【问题标题】:StyleCop Team Development concrete stepsStyleCop 团队建设具体步骤
【发布时间】:2025-06-24 13:45:01
【问题描述】:

我正在尝试以 StyleCop 检查 C# 样式的方式设置 Visual Studio 2015 解决方案,并且一旦提交到源代码管理,其他开发人员无需执行任何其他操作即可遵循相同的样式规则并获得StyleCop 自动发出相同的错误/警告。

正如StyleCop documentation pageGitHub StyleCop 在标题团队发展 下描述的(实际上两者都说相同):

将所有文件从 {Program Files}\MSBuild\StyleCop 复制到自定义文件夹中

在我的情况下,C:\Program Files (x86)\MSBuild\StyleCop\v4.7 只有一个文件:StyleCop.Targets

搜索任何 StyleCop.dll 会将我带到另一个文件夹 (C:\Program Files (x86)\StyleCop 4.7),其中包含许多子文件夹、dll、xml、exe、lex... p>

现在我的问题:

哪些是需要上传到项目并因此上传到源代码管理的确切文件?

配置项目中要做哪些更改?

注意:

到目前为止,我看到上下文 StyleCop 菜单允许我进行代码分析和检查。

【问题讨论】:

    标签: c# msbuild visual-studio-2015 stylecop


    【解决方案1】:

    要使用安装,您需要让每个开发人员在他们的机器上(以及在任何构建服务器上)安装 StyleCop 程序。

    有一种更简单的方法...改为为每个项目使用 StyleCop.MSBuild nuget 包:

    这为每个 csproj 添加了一个 StyleCop 指令,指向 packages 文件夹中的实例,这意味着它可以转移到每个开发机器和任何构建服务器,而无需它们做任何事情。

    然后,一旦项目中没有错误,请使用 StyleCop.Error.MSBuild 保持这种状态,再次来自 nuget:

    这会将<StyleCopTreatErrorsAsWarnings>false</StyleCopTreatErrorsAsWarnings> 添加到 csproj,但又将其保留在 nuget 中,我个人认为这是一种更简单的跟踪方法。

    【讨论】:

    • 非常感谢!即使我在Package-Manager中找不到它,但是在Package Manager Console中输入时没有问题:“Install-Package StyleCop.MSBuild”。