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


当前回答

private static final Logger lager = new Logger();

其他回答

有一次我发现:

// I wish (boss name) could do this by him self.

在20世纪80年代早期的某个时候,我们在PL/I中为公用事业编写财务建模代码。接到一个客户的电话,说代码在评论之后就爆炸了

/* Honest this works */

这家伙用了我们的标准金融方程花了大约15页的代数把一堆代码组合成一个方程。在三里岛事件后,当公用事业公司不得不以巨大的代价注销他们的核电站时,这个方程失败了,因为FIXED BIN 15(整数)溢出,如果代数没有发生,就不会发生这种溢出。

消毒:

//Forward declarations:

class X {}; // TODO: Remove {}  ! When we get X defined....

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

// TODO: Need some codemonkey to doc comment this class.
/**
 * Always returns true.
 */
public boolean isAvailable() {
    return false;
}

永远不要依赖评论……