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


当前回答

我们有一个文件,在它的一半,一个程序员试图弄清楚混乱的意义,设法将所有无意义的代码移到底部,并留下了这样的评论:

I have no idea what this stuff does below here.

另一名程序员留下了一系列嵌套的命名空间,这些命名空间的作用类似于“方向手册”,这样您就可以钻取想法中的名称空间并选择您的操作。

其他回答

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

在linux 1.0内核调度器(schedule .c)中:

Dijkstra可能讨厌我。

/*
 *  'schedule()' is the scheduler function. It's a very simple and nice
 * scheduler: it's not perfect, but certainly works for most things.
 * The one thing you might take a look at is the signal-handler code here.
 *
 *   NOTE!!  Task 0 is the 'idle' task, which gets called when no other
 * tasks can run. It can not be killed, and it cannot sleep. The 'state'
 * information in task[0] is never used.
 *
 * The "confuse_gcc" goto is used only to get better assembly code..
 * Dijkstra probably hates me.
 */
asmlinkage void schedule(void)

(…)

在一个名为“Bar”的类中(这是一个不具有描述性名称的UI控件),类头文件:

/// <summary>I pity the "foo".</summary>

Remove()方法:

/// <summary>A "foo" and his money are soon parted.</summary>

更糟糕的是,业务合作伙伴从生成的文档中指出了这一点。更糟糕的是,这些可能是我们从那家伙那里得到的最接近有用文件的东西。

我看到有人对代码的评论:

// This comment is self explanatory.

我猜他是想说“可变的”,但这个错误造成了一个有趣的评论……想想这里的循环逻辑,以及写它的徒劳。

Exception up = new Exception("Something is really wrong.");
throw up;  //ha ha