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


当前回答

// This condition can't happen. Call the police or something.

其他回答

//Maybe you should make anyone knows your code's purpose. 

在几年前编写Perl时,我在顶部和底部添加了这些注释:

# <magic type="voodoo">

...

# </magic>

下一个研究它的人在Perl中并不是那么热门,他花了一段时间搜索文档,看看“魔法”和“巫毒”是怎么做的。从那以后,我试着添加更多有用的评论……

我曾经使用MS SQL Server Developer 2000实现了一些文档工作流(人工工作流的东西)。

它由一堆触发器组成,这些触发器将被添加到数据库中,使其遵循工作流规则。

在其中一个触发器中,微软的某个人写了如下内容:

//Determine if the database has been "Grizzlified"

(该产品的内部名称是“Grizzly”,所以我觉得这很有趣)。

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

一段时间前我在一个PHP CMS中添加的注释。

if (/*you*/ $_GET['action']) { //celebrate