/* Jeez, this is an ugly mess */

...comment from the X11R6 internals source code circa 1991.

在一个巨大的800行'switch'语句中，在中间的某处:

// Joe is sorry

几百行之后……

// Harry is sorry too

<!-- THIS IS THE MAIN CONFIGURATION FILE FOR THE ENTIRE BLOODY DIRECTORY    -->
<!--    WHATEVER YOU DO, DO NOT EDIT THIS FILE WITHOUT TALKING TO ME FIRST  -->
<!--                                I'M SERIOUS                             -->
<!-- (scroll down) -->

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

例子:

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

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

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

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

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

在几年前编写Perl时，我在顶部和底部添加了这些注释:

# <magic type="voodoo">

...

# </magic>

下一个研究它的人在Perl中并不是那么热门，他花了一段时间搜索文档，看看“魔法”和“巫毒”是怎么做的。从那以后，我试着添加更多有用的评论……