如何在保持StyleCop开心的同时将常规评论分解为段落?

时间:2010-08-03 15:52:10

标签: c# comments stylecop

有时候需要冗长的评论。当有一个需要长时间解释的虚假黑客时,就会发生这种情况。是的,最好完全避免/修复黑客攻击,但通常会有时间压力,而且必须将其推向未来。如果是这种情况,那么详细的评论是非常有用的,包括那些用更好的代码替换黑客的人。关键是确保他们确切了解黑客正在做什么以及为什么。

通常需要多个段落。如果允许使用//等空白评论,评论将更具可读性。但是,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>

(我也不喜欢第三种选择。它非常适合///方法文档,但在这里它看起来有点不合适。

请建议一个更好的方法。

2 个答案:

答案 0 :(得分:3)

/ *
每当我得到一个冗长的评论,无论原因,我使用“slashterix”'块评论'样式。

一直对我有用。
YMMV,但这是我最好的建议。 8)
* /

答案 1 :(得分:0)

为什么不直接使用换行符?

// Some comment
// Some comment

// Some more comments
// Some more comments

// Yet more comments
// Yet more comments
int x = 2;