// Caveat implementor

我经常发现这个

// fix it!

从一个遗留的Perl CGI脚本:

# This is convoluted and evil, sorry.

来自usenet的经典:

Teradyne硬件建模器代码的深层是一个例程 一大堆十六进制数字到SYS$QIO调用中。唯一的评论是 “这里发生了奇怪的魔法”。

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

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

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

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

// 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}

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

/* Hammer Time! */

我不知道为什么，也不知道他在写代码时是否穿着防撕裂尼龙降落伞裤