“常识”或实用.NET编码标准

Question

我即将更新我们的编码标准文档，我想也许正在以比通常更高的水平编写它们。我们有相当数量的开发人员来来往往，他们通常具有中级技能水平。我想消除低质量的“绒毛”部分......例如，“变量命名约定”等......任何真正具有可疑价值的东西，会分散文档中具有真正价值的部分（由于价值过低，可能会被撇去或完全跳过。）

我也更感兴趣的是确保人们不做蠢事，而不是强迫他们以某种方式做事。

我们碰巧是.Net / Oracle商店，但对于我所寻找的材料类型，我认为语言不是特别重要。

我想知道是否有人之前已经这样做并且有一些他们不介意分享的材料，或者遇到过类似性质的任何好的在线资料？

Answer 1

根据我的经验，编码标准的实用价值与其自动测量的能力成正比。我们商店的部分C＃编码标准（适用于一页）表示，根据FxCop和StyleCop的默认规则，代码必须是干净的。这两个工具都可以由开发人员和构建过程运行。

Answer 2

我绝对比标准文档更喜欢工具选项ReSharper。我越专业，我就越发现编码标准文件是浪费时间，而且往往会导致生产力下降。

代码应该是可读的和可理解的。不幸的是，编码标准也不能强制执行。但是，工具至少可以强制执行命名约定并帮助查找诸如无法检查null或“访问已修改的闭包”等问题。

无论如何，编码标准绝不应该让开发人员不要编写好的代码。我见过禁止使用三元运算符或运算符重载的文档。我还看到了需要对代码进行充分评论的文档（我尽量避免使用评论来支持可读代码）。在我看来，这些事情都不应该符合编码标准。

Answer 3

MSDN上的guidelines for class developers有很多好材料。很多像你想要消除的低级别的东西，它在实际方面肯定更多，但值得一看。

Answer 4

或许只有一个关于JP发布的指导原则或该代码的部分应该通过FxCop并获得一些最低分数，以便覆盖这些内容并且开发人员没有理由不这样做。这将为您的标准提供更多空间，以用于特定于域的指南。