coding-style - 该字段必须具有文档标题-样式警察-代码有异味？

Question

我只是针对一些代码运行样式警察，但得到了一些:

SA1600: The field must have a documentation header.

现在不要误会我，我喜欢样式警察，当您与一个以上的人一起进行项目时，这很棒，但是对我来说，这条规则似乎有点过分。您为什么要添加:

    /// <summary>
    /// blah blah blah
    /// </summary>

到每个变量的顶部我敢肯定，我记得有人说过(马丁·福勒，肯特·贝克。真的不记得ATM)，评论应该说“为什么”而不是“什么”，而且我真的看不到如何解释为什么变量。

我还发现在每个变量上都有注释的代码更难阅读，因为您看到的只是绒毛。

我的想法是，如果您必须解释每个变量的含义，那么您在命名方面确实失败了。

还有其他人发现注释变量有点代码味道还是仅仅是我自己。

Answer 1

我不会说注释变量始终是代码的味道(听起来也不是您要说的那样)。我确实同意，至少每一次对每个变量进行注释，至少是过多的注释，并且可能表示命名不正确。实际上，有些人会认为任何注释都是代码的味道，描述性名称和简短的例程更具可读性，可以防止代码已更改但注释尚未更新的情况(这肯定使我陷入了困境。少量旧代码库)。我认为我不会那么做，但是如果您可以编写无需说明的自我解释代码，那似乎更可取。

是的，基本上是您所说的。