// If this comment is removed the program will blow up 

几年前，我在一个没有单元测试可言的大型代码库中工作。

代码中隐藏了一个执行一些日历计算的方法。它有点坏了，由于一些不幸的情况，不得不以一种非常笨拙的方式处理夏令时。

我们不得不修了几次，每一次，我们都会在几个月后发现一些东西坏了。

在花了一整天的时间修复和分析之后，我把代码放到了源代码控制中，并附上了这样的评论:

// this code was written after a version trying to do {this} failed because of {reason},
// previously we were doing {this} which failed because of {reason}. This is 
// now written {this} way so that {lots of reasons here}. If you want to touch
// this code, please make sure that it produces the right answers when tested with:
//
// {some sort of unit test}

最终，我的团队被外包了。有时我想知道这段代码发生了什么:)

// sometimes I believe compiler ignores all my comments

//Mr. Compiler, please do not read this.

我曾经在一个项目中发现了这样的评论:

// Cabbage fart?

我不知道那是什么意思。还好我的魔方不在写它的人旁边。

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

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

Remove()方法:

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

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