有时需要冗长的评论。当有一个需要长时间解释的 fugly hack 时,就会发生这种情况。是的,最好完全避免/修复黑客攻击,但通常会有时间压力,必须将其推迟到未来。如果是这样的话,那么有一个详细的评论是非常有帮助的,包括那些将用更好的代码替换 hack 的人。关键是要确保他们确切地了解黑客正在做什么以及为什么。
这通常需要多个段落。如果允许这样的空白评论,评论将更具可读性//
。但是,StyleCop
不喜欢那些,我们总体上同意它,所以我们尝试坚持它的所有建议。现在,我可以想到三个选项:
//// This is a hack ...
//// ..................
////
//// When fixing this hack make sure ...
//// ...................................
(我不喜欢第一个,因为我通常使用双/三/四注释来注释掉代码段)。
// This is a hack ...
// ..................
//// <== This will slide, but I think it looks dumb.
// When fixing this hack make sure ...
// ...................................
(我不喜欢第二种选择;我认为它看起来有点愚蠢)
// <para>
// This is a hack ...
// ..................
// </para>
// <para>
// When fixing this hack make sure ...
// ...................................
// </para>
(我也不喜欢第三种选择。它非常适合///
方法文档,但在这里它看起来有点不合时宜。
请提出更好的方法。