曾经有一个为我工作的程序员在他的代码中加入了“Style”注释，他在代码中编写了关于特定实现细节的内部争论，当他在某个特定的编码决策上被否决时，他就会离开。

例子:

的风格 '这是有争议的，但我传递图像句柄，而不是简单地 '传递缩放值，以保持调用代码更简单(通过a '一对声明语句)。或者，我可以传递这些数据 成员，但这将违反封装。

的风格 就像我在其他地方做过的一样，我将正式提出抗议 的表格)，将注释序列化的实现视为 '一个属性，而不是一对Load/Save方法。这可能是 “风格的问题，值得商榷。

消毒:

//Forward declarations:

class X {}; // TODO: Remove {}  ! When we get X defined....

If you have reached this part in the code, then this program sucks.

从谷歌代码项目:

# This job would be great if it wasn't for the fucking customers.

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

A:很简单——就是那个帮我解决了我当时遇到的任何问题的人，而且有很多这样的人!

其次是那些帮助指导新开发避免已知陷阱的方法。

我最喜欢的评论是我的一个同性恋朋友说的。他喜欢用VB标记他所有的TODO注释。净,

'TODO: Matt Damon

有时会提供额外的信息，但通常不是这样。