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


当前回答

这一点对其他人来说很有趣,但对我来说就不那么有趣了。我从一个开发人员那里继承了代码(ASP),而他自己也继承了它。第一个程序员编写了一些很难理解的代码。第二个开发者添加了如下评论(为了保护不那么无辜的人,名字被隐藏了):

'This code was written by **************.
'I haven't a clue what it does. He hasn't a clue what it does.
'Nobody else has a clue what it does or how it does it.
'It is something to do with data but **** knows what.
'The ******* still works so please do not change this code,
'even though it is a complete pile of ****.

那我为什么不觉得有趣呢?嗯,这是一个客户内部网的ASP代码。

...正是那位顾客向我强调了这条评论。

:-(

其他回答

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

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

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

//Determine if the database has been "Grizzlified"

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

所有bug由David S. Miller添加

// fix for groupid > 9 
// if groupid ever gets to 100 everything will break (again)

if (groupid < 10) {
groupid = "0" + groupid;
}
aComment = 'this is not aComment' # this is aComment
class T(object):
    def f(this):
        this is not aComment

http://fxr.watson.org/fxr/source/pci/if_rl.c 是好的来源。