tfs - 将 StyleCop 与 TFS CI 集成的最佳方式

Question

我一直在研究如何为我正在从事的项目启用源代码分析，并计划使用 StyleCop。我的设置是使用 TFS 持续集成进行源代码控制的 TFS 服务器。我希望为 CI 构建和在构建机器上运行的日常构建启用源代码分析，而不仅仅是在开发人员机器上运行的构建。

这是我阅读的 StyleCop 文档中关于该主题的一篇文章: http://blog.newagesolution.net/2008/07/how-to-use-stylecop-and-msbuild-and.html 。它基本上是为了达到目的而修改 csproj 文件。

我还阅读了有关 StyleCop 应如何与构建自动化集成的其他意见，这些意见建议使用构建任务执行相同的操作:

http://blog.newagesolution.net/2008/07/how-to-use-stylecop-and-msbuild-and.html http://freetodev.spaces.live.com/blog/cns!EC3C8F2028D842D5!400.entry .

你有什么看法？您有过类似的项目并做过类似的事情吗？

Answer 1

一般使用 StyleCop 的一些要点:

• 您不需要在您(或构建)计算机上安装 StyleCop - 只需将 StyleCop 的二进制文件添加到您的源代码管理中(大约 1.5 MB 的内容)

• 然后只需添加对项目文件的相对引用，如下所示(我省略了 < 和 >):

  导入项目=“..\..\lib\Microsoft StyleCop\Microsoft.StyleCop.Targets”

• 我们使用项目文件中的 StyleCopTreatErrorsAsWarnings 设置将所有 StyleCop 警告视为错误。

• 对于旧项目，您可以使用 Microsoft 提供的工具自动将所有现有源文件设置为忽略。
• 您可以将 StyleCop 设置文件 (Settings.StyleCop) 放在 VS 解决方案所在的根目录中(当然也将其置于源代码管理之下)。 StyleCop 知道如何自动找到该文件(通过查找目录树)。这样您就可以为每个解决方案进行自定义设置。
• 我们关闭了某些我们认为不太实用的 StyleCop 规则。

这样，StyleCop 将集成到您的编译步骤中，因此它将成为 CI 构建的一部分。