你遇到过的源代码中最好的注释是什么?


当前回答

// Singleton object. Leave $me alone.
private static $me;

其他回答

try {

}
catch (SQLException ex) {
    // Basically, without saying too much, you're screwed. Royally and totally.
}
catch(Exception ex)
{
    //If you thought you were screwed before, boy have I news for you!!!
}
// If I from the future read this I'll back in time and kill myself. 

我刚刚完成了一个日志框架(使用Trace,为什么没有这样的存在我不知道)。我做了一个继承自TraceListener的方便基类。它覆盖了所有的TraceListener方法,并将它们路由到一个方法中——因此有很多文档注释:

// TODO: Need some codemonkey to doc comment this class.
/* Look not upon this file lest your eyes be burnt from your head. */

我能说什么呢?我当时是实习生,夏天快结束了。我们可以说,我对我的文件责任缺乏认真的承诺。

我在遗留代码中注意到的修改日志

05/17/99 d琼斯评论出来 血腥的auzies代码(02/19/99) k罗宾逊该死的德克萨斯人 不能正确拼写aussie(没有代码 改变-只是一个评论)