在编写开源库时,我应遵循哪些StyleCop规则

时间:2008-12-02 13:59:52

标签: .net open-source stylecop

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

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

2 个答案:

答案 0 :(得分:5)

StyleCop的一般想法是:所有这些:)

您关闭的选项越多,StyleCop在执行一个真实的代码格式时所拥有的值越少。话虽这么说,如果你不喜欢某些选项,那么一些选项总比没有选择好,将StyleCop设置文件包含在你的代码中,然后其他选项可以使用相同的设置。

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

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

答案 1 :(得分:0)

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

首先,我建议您搜索您感兴趣的操作系统项目的常见问题解答,然后从那里开始。

无论如何,我相信如果你在很大程度上打破任何现有的风格规则,会有很多人会很快告诉你! ; - )

注意所有警告,通常他们试图告诉你一些有用的东西。不像语用程序员那样完成“巧合编程”(book excerpt)!

编辑:我没有意识到这是你自己的新的OS项目。我的错。无论如何,我对一些类似的现有操作系统项目进行了嗅探,看看他们是否有任何风格指南。当然,请查看史蒂夫麦康奈尔的书代码完整(Amazon link - 为在这些大厅漫游的脚本小子链接纳粹消毒了。)

我所说的警告和“巧合编程”仍然适用! ( - :

HTH。

欢呼声,

罗布