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


当前回答

这实际上是我在实现原型转换为实际代码时所做的:

// Abandon all hope you who needs to debug this

是的,有比我聪明的人在之后重构了代码(它必须有一个好的结局)。

其他回答

我所见过的最好的评论是

/* 
  There is no accounting for pointers 
*/

几年前我在。h文件里看到的。

// It may be a hack, but it works.
// This code sucks.

这是众所周知的,但我喜欢它(在sys/ufs/ufs_vnops.c中):

/*
 * A virgin directory (no blushing please).
 */

在FreeBSD内核源代码树中(甚至在之前,回到4.xBSD)

Many years ago (about 1994) I was working on a Oracle PRO*C application for a large multi-national software company that you will have heard of. The app I was working on was a massive Oracle application and they had a utility that ran overnight tidying up data and doing all sorts of aggregate calculations. Every time anything needed doing as a batch job, it got shoved into this utility and as you can imagine it became an absolute monstrosity. It was also notable for the tiny number of comments that it had for such a massive program.

它为数不多的评论之一仍然是我所见过的对纯粹的WTF的最好的评论……我试图在一个函数中找到一个bug,它有数百行长,中间是函数中唯一的注释:

/* I did this the other way */

直到今天,这仍然是我所见过的最好的评论。