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


当前回答

-- Beyond this point, there'll be dragons

我觉得更长的说法^^更能说明问题

其他回答

// If I from the future read this I'll back in time and kill myself. 
-- Change Log:  Not needed. The code is perfect 'cause I wrote it.
-- If you change it, it will break.

我正在检查一些代码注释,以检查它们是否有意义,并看到上面的一行。

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

/* Honest this works */

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

我经常看到这种情况:

// TODO make this work
/**
 * Always returns true.
 */
public boolean isAvailable() {
    return false;
}

永远不要依赖评论……