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


当前回答

有一些旧的javascript代码,写得很好。然后是一条评论线

// and there is where the dragon lives

接下来是一个功能,4个人花了一天时间来理解它在做什么。最后我们意识到它根本没用,什么都没有。

其他回答

// TODO - Comment this function
// Bad Christian, No cookie

这里的Cookie不是指浏览器Cookie

在头文件的顶部:

/* Project : XYZ (Please somebody shoot me!)
 *
 * File : $Id: defs.h,v 1.1 $
 *
 * Purpose : Create havoc rather than peace among many nations
 *
 * History : Back-ported changes that were not in CVS.  Please somebody,
 *  shoot us and put us all out of our misery.
 */

“XYZ项目”(已改名)是一个长达七年的折磨。最后这句话是由一个从头到尾都参与其中的坚定的灵魂写的。

我最喜欢的是已故的Paul DiLascia:

//作者:如果这段代码工作,它是由Paul DiLascia写的。如果不是,我就不知道是谁写的了。

//ALL YOUR BASE ARE BELONG TO US

...这让我的老板以为有人黑进了系统。他不知道这个笑话。