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


当前回答

从http://www.madore.org/ ~大卫/电脑/ callcc.html:

/* Yow!  DEMONS are flying through my NOSE! */

其他回答

一些源代码中的德语注释,由机器或非常疲惫的人翻译+谷歌

; Rechnen ja ; have faith in yes

我猜原来的意思是“假设这里是真的”…但从那以后,我就把它当成了人生的咒语。

aComment = 'this is not aComment' # this is aComment
class T(object):
    def f(this):
        this is not aComment

BerkeleyDB

/*
 * Chaos reigns within.
 * Reflect, repent, and reboot.
 * Order shall return.
 */
return (DB_RUNRECOVERY);

我参与的一个大型项目在自动构建中使用了StyleCop和FXCop,并使用规则来防止人们检入带有未注释字段、方法、属性等的代码。

有些人对必须添加“获取或设置全名”之类的注释到自记录属性(如FullName)感到非常恼火,以至于他们不得不努力编写一个宏来绕过这些规则。

宏为方法、属性等插入了XML摘要标记,其中一个单一的不显示Unicode字符作为标记内容,这将欺骗构建规则,同时对为了注释而盲目坚持的东西进行轻微打击……

...至少直到他们引入了另一条规则来检查注释中的Unicode字符。

目前为止最好的一个:

"This code makes baby Jesus very sad!". 

它像这样引用一个String的初始化:

String blankSpaces="                              "+ //100 whitespaces
                   "                              "+ //200 Whitespaces
                   ...
                   "                                        " //100 whitespaces

你懂的。