.net - 编写开源库时应该遵循哪些 StyleCop 规则

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗？更新问题，以便可以通过 editing this post 用事实和引文回答问题.

6年前关闭。




Improve this question




我目前正在为 COM 对象编写一个开源包装器。我刚刚安装了 StyleCop 并针对我的一些代码运行它，正如我预期的那样，它抛出了大量警告(其中一些我应该已经做了，例如将“this.”添加到所有本地方法调用和变量中)

我应该尝试减少多少这样的警告？在编写开源库时，哪些是最好的？

Answer 1

StyleCop 的总体思路是:所有这些 :)

关闭的选项越多，StyleCop 在强制执行单一代码格式方面的值(value)就越小。话虽如此，如果您不喜欢某些选项，那么某些选项总比没有好，将 StyleCop 设置文件包含在您的代码中，其他人可以使用相同的设置。

如果您不熟悉 StyleCop，某些设置一开始可能看起来很奇怪，但使用它两年后我保留了所有选项，我们的团队对结果非常满意。

我还要说，如果您提供使用 FxCop 的库或框架可能比使用 StyleCop 更重要。