编写开源库时应遵循哪种StyleCop规则

Question

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

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

Answer 1

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

的更多选择你关掉价值不大了StyleCop。已经实施了一种真正的代码格式。话虽如此，如果您不喜欢某些选项，那么某些选项比没有选项好，请将StyleCop设置文件与您的代码一起使用，然后其他人使用相同的设置。

如果您对StyleCop不熟悉，但是已经使用了两年，我将所有选项都留下，我们的团队对结果非常满意，但一些设置看起来可能很奇怪。

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

Answer 2

大多数大型开源项目都有自己的风格指南。例如，这里是Apache C Language Style Guide。

作为一个开始，我建议您抓取您感兴趣的操作系统项目的常见问题解答，并从那里获取它。

无论如何，我敢肯定会有很多人会很快让你知道，如果你打破了现有的任何风格规则！ ;-)

注意所有的警告，通常他们试图告诉你一些有用的东西。不要像语言程序员所说的那样，通过巧合来编程（book excerpt）！

编辑：我没有意识到这是你自己的新的OS项目。我的错。无论如何，我会嗅探一些类似的现有OS项目，看看他们是否有任何风格指南。当然，看看史蒂夫麦康奈尔的书代码完整（Amazon link - 消毒脚本kiddie链接纳粹漫游这些大厅）。

我说的关于警告和“巧合编程”仍然适用！ （ - ：

HTH

欢呼声，

罗布