【问题标题】:Which StyleCop rules should I follow when writing a open source library [closed]编写开源库时我应该遵循哪些 StyleCop 规则[关闭]
【发布时间】:2008-12-02 13:59:51
【问题描述】:

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

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

【问题讨论】:

    标签: .net open-source stylecop


    【解决方案1】:

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

    您关闭的选项越多,StyleCop 在强制执行唯一正确的代码格式方面的价值就越小。话虽如此,如果您不喜欢某些选项,那么有些选项总比没有好,请将 StyleCop 设置文件包含在您的代码中,然后其他处理它的人可以使用相同的设置。

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

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

    【讨论】:

    • 很好地呼吁 FxCop。他们一起组成了一支伟大的团队!
    【解决方案2】:

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

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

    不管怎样,我相信会有很多人会很快让你知道你是否在很大程度上违反了任何现有的风格规则! ;-)

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

    编辑:我没有意识到这是您自己的新操作系统项目。我的错。无论如何,我会对一些类似的已经存在的操作系统项目有所了解,看看它们是否有任何风格指南。当然,请查看 Steve McConnell 的书 Code Complete(Amazon link - 为漫游这些大厅的脚本 Kiddie Link 纳粹清理)。

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

    HTH。

    干杯,

    罗伯

    【讨论】:

    • 这是我自己的开源项目,所以没有常见问题解答或样式....但是。
    猜你喜欢
    • 2012-05-30
    • 1970-01-01
    • 1970-01-01
    • 2013-12-08
    • 1970-01-01
    • 1970-01-01
    • 2017-11-27
    • 1970-01-01
    • 2011-06-08
    相关资源
    最近更新 更多