如何解决“StyleCop C# 风格”与“StyleCop C# 风格”之间的差异？ 和“框架设计指南 C# 风格”？

Question

在阅读了《框架设计指南》（2008 年 11 月第 2 版）这本书的附录 A“C# 编码风格约定”后，我对 Microsoft 内部使用/推荐的编码风格感到非常困惑。

博客文章 C# 风格简史声明：

事实上，“StyleCop风格”和“Framework DesignGuidelines风格”之间的差异相对较小

在我看来，差异非常明显。 StyleCop 说左大括号应该在单独的一行上，框架设计指南说它应该在左括号之后。 StyleCop 说所有关键字后面都要跟一个空格，框架设计指南说“摆脱所有空格”（甚至在二元运算符周围）。

我发现《框架设计指南》书中的这条规则特别讽刺（第 366 页，从上往下数第 6 条规则）：

不要在流程控制语句之前使用空格

右：while(x==y) 
  错误： while (x == y) 
  

这明确表明StyleCop风格是错误（while关键字之后的空格，相等二元运算符前后的空格）。

最后，使用 StyleCop 风格格式化的代码与使用框架设计指南风格格式化的代码具有完全不同的“感觉”。 通过遵循框架设计指南风格，人们将不得不禁用一堆规则（并且没有规则检查是否遵守框架设计指南风格......）。

有人（也许是微软内部人士？）能否解释一下这种分歧？

您的团队如何处理这个问题？ 关注 StyleCop？ 框架设计指南？ 完全忽略风格？ 烘焙自己的风格？

Answer 1

stylecop 团队的这篇文章准确地解释了我认为您所问的问题。
http://blogs.msdn.com /sourceanalysis/archive/2008/05/25/a-difference-of-style.aspx

为了回答您问题的第二部分，我们的团队刚刚开始使用 StyleCop 使用所有规则（有些人挑选哪个）的使用）。 我唯一不喜欢的是它需要额外的时间，但是使用像 StyleCopForResharper 这样的工具可以让它运行得更快。 以前，当人们编写的代码与我编写的代码看起来不同时，我会感到非常恼火，但现在我们使用 StyleCop，每个人的代码看起来都一样。 不再对人们所做的烦人的事情咬牙切齿

Answer 2

我在博客上读到了这一点（我似乎找不到网址），其中写道：
框架指南基于 C++ 指南并由其演变而来（他们都是经验丰富的 C++ 开发人员），而 stylecop 提供的指南是更现代的新 C# 指南...
两个都可以，自己决定吧……我个人用的是StyleCop的

Answer 3

我们所有的代码都使用 StyleCop，除了一些小问题之外，我认为它的大部分标准都导致了最具可读性的代码。 它的许多标准已经在 Microsoft 内部进行了深入讨论，并得到了社区的反馈，虽然并不期望每个人都会同意所有内容，但它可能是最好的“标准”（特别是因为它允许自动验证，以及使用 StyleCop for ReSharper 插件自动更正）。

如果有任何您强烈不同意的事情，维护该工具的 Jason Allor 对某些事情的建议非常开放，例如 StyleCop 最初坚持的自动属性......

public int Prop
{
    get;
    set;
}

但我们提出了更改请求以允许单个行属性（即一行上的所有内容），因为它的可读性并没有降低，并且占用的空间也更少。 他在几天内做出了这一改变。

Answer 4

你做出决定。 如果您喜欢其中一个的某些部分和另一个的某些部分，请编写您自己的风格指南。 如果您比另一种更喜欢其中一种，请选择它。

最重要的是选择一种风格； 没有办法以任何严格的定量方式对彼此进行评估。