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


当前回答

// this error could never happen

然后,客户打电话说他看到一条错误消息说"这个错误永远不会发生"

其他回答

在我们的应用程序中第一次重新编译FreeTextBox3,因为我们需要IE8支持…看看我发现了什么

// IE7 update. this is still bad code, but IE8 is probably a long way off :)

在给一个朋友看了这篇来自《Coding Horror》的文章几个小时后,我看到了他对代码的评论:

// valdez先生是一个暴力的精神病患者。别惹他生气。

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

# <magic type="voodoo">

...

# </magic>

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

// THE LOOP THAT DO EVERYTHING!!!!!!!
// TODO: Implement this function!