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


当前回答

//Dave chapelle reports errors.
function reporterror() {
  davechapelle.trace("FUCK!");
}

其他回答

用于政府目的的企业等级系统中的评论

'RH 5/24/06 burn me if this dosn't work.. :)

好RH.....公司总裁/首席开发人员

我刚刚注意到自己在写这个

// not brilliant solution, but fair enough heh.

有一次,我问一个同事如何用我们的内部框架做一些事情(忘了具体是什么,一些晦涩的技术调用)。 他说“简单,看这里”,然后在他的编辑器中打开一个。java文件,在几页代码中间给我看了这个注释:

// HERE

我刚刚检查了一下,注释仍然在这个文件中:)

我最喜欢的是一个用java编写的学校项目的一些业务逻辑中的一个变量名。

int StupidJava = -1;

这一点对其他人来说很有趣,但对我来说就不那么有趣了。我从一个开发人员那里继承了代码(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代码。

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

:-(