c# - StyleCop 和/或一般风格指南？

Question

类似问题:Styleguide for C#和 StyleCop: a complete document

好的，所以我正在为我们在 C# 中开发的应用程序在我的工作场所寻找某种样式控制。我最初只是计划制作一个风格指南(通过收集一些现有的风格指南并从中挑选合适的部分)，但看起来 StyleCop 可能是一个很好的补充或替代风格指南。

所以，我的问题是:

1. 风格指南和/或 StyleCop 的潜在问题是什么我可能会遇到什么？
2. 如果我使用 StyleCop，我希望风格指南有多相似？我是否想尝试阻止/限制这两种方法之间的任何差异？我问是因为如果 StyleCop 不强制执行它，那么它可能会被忽略(或者这不是什么大问题？)。
3. 如果我使用的是 StyleCop，是否值得花时间和精力创建样式指南？
4. 是否有任何值得研究的 StyleCop 替代品？ (例如，具有非常好的替代方案可用性/定制和“可以”被认为是足够的自己)。

编辑: 只是一点点背景，我的工作场所有一个“软件部门”，现在才真正成立。有 3 个全职 c# 开发人员，3 个可能接触/使用/更改 c# 代码的开发人员，一些 BA，没有官方测试人员。

Answer 1

在一个使用/维护/执行风格指南的团队，然后在一个使用 StyleCop 的团队工作之后，我的建议是只使用 StyleCop。这有几个原因:

1. 它是编译时强制执行的。对于像风格这样挑剔的东西，这是一个巨大的优势。使用样式手册总是有灰色区域，但没有任何编译器错误。这将风格争论从“这是错误的”/“不，它不是”减少到“我们应该更喜欢哪个”，这是(通常)更文明的争论。

2. 如果您创建自己的风格，则需要有人(或你们所有人)充当人类“风格警察”，这是一项相当痛苦的工作。开发人员(以我的经验)往往不喜欢人们对他们提交的代码进行“风格调整”，并且更不喜欢被告知让他们的代码符合风格。这也很耗时，因为在代码审查期间审查是另一回事(你正在做那些，对吧？)。

3. StyleCop 带有一组相当不错的默认规则，仅使用这些规则就可以匹配大多数其他 C# 代码库。当我使用我们自己的内部风格手册时，所有的开源代码看起来都很陌生，因为我们使用了注释标题、大写参数、一些匈牙利符号等。但是当我转向带有默认规则集的 StyleCop 强制风格时，一切看起来很眼熟!

4. 创建您的风格意味着您将花费大量时间重新发明轮子，然后在出现边缘情况和争论时维护该轮子。这是一个非零的工作量，并且会浪费很多时间；根据我的经验，开发人员总是争论代码风格。

5. 如果您不喜欢某些默认设置或需要添加 StyleCop 应忽略的缩写，它有一个不错的编辑器来配置您的规则集。

6. 您可以编写自己的规则或使用其他人发布的规则。例如，我们团队中的一些人讨厌尾随空格，所以我包括了 these rules来强制执行。

就替代方案而言，我不知道有任何替代方案能像 StyleCop 一样无缝。我应该指出，我只将它与 Resharper/Visual Studio 结合使用，所以如果你有不同的环境，那么你的里程可能会有所不同。