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


当前回答

// now that's compact!
list->insert(list->end(),**pitch)->IdxOfSample=(pitch->pos-Offset)*SamplingRate;

其他回答

// now that's compact!
list->insert(list->end(),**pitch)->IdxOfSample=(pitch->pos-Offset)*SamplingRate;

在一组相当长且复杂的while循环和if块的末尾,开发人员插入了最后的注释:

else
{
    // wobbly wilson said this would *never* happen!!
}

机智和讽刺的简洁混合:)

options.BatchSize = 300; //Madness? THIS IS SPARTA!

我参与的一个大型项目在自动构建中使用了StyleCop和FXCop,并使用规则来防止人们检入带有未注释字段、方法、属性等的代码。

有些人对必须添加“获取或设置全名”之类的注释到自记录属性(如FullName)感到非常恼火,以至于他们不得不努力编写一个宏来绕过这些规则。

宏为方法、属性等插入了XML摘要标记,其中一个单一的不显示Unicode字符作为标记内容,这将欺骗构建规则,同时对为了注释而盲目坚持的东西进行轻微打击……

...至少直到他们引入了另一条规则来检查注释中的Unicode字符。

不是一个评论,而是一个goto标签

ICantBelieveImUsingAGoto: