使用 StyleCop 在文档标题中添加作者姓名答案

【问题标题】：Adding Author Name in document Header using StyleCop使用 StyleCop 在文档标题中添加作者姓名
【发布时间】：2012-02-26 17:10:20
【问题描述】：

我在 Visual Studio 中使用 StyleCop。每当我添加一个新文件时，它都会添加一些信息，例如公司名称、版权详细信息。我还想添加作者姓名和创建日期。是否可以在某处更新 StyleCop 设置以支持此功能？

【问题讨论】：

您是在谈论添加新的 StyleCop 规则以检查信息是否存在，还是使用 StyleCop 附带的新模板？
不添加规则..就像添加新模板一样，随着公司名称等，作者姓名和创建日期将随之而来

标签： visual-studio-2010 stylecop

【解决方案1】：

StyleCop 模板位于相对于 Visual Studio 安装位置的 /Common7/IDE/ItemTemplates/CSharp/Code/1033（VS2010 默认为 C:/Program Files/Microsoft Visual Studio 10.0 或 C:/Program Files (x86)/Microsoft Visual Studio 10.0，如果两者都存在，请先在 x86 文件夹中查找）。

模板以 zip 文件的形式提供，其中包含一个 .cs 文件和一个 .vstemplate 文件。解压 zip 文件，修改.cs 文件，重新压缩这两个文件并将其放回原始文件夹（我建议创建原始备份以防万一）。为了让 Visual Studio 实际使用您修改后的新模板，请在命令提示符下运行此命令：

"%ProgramFiles%\Microsoft Visual Studio 10.0\Common7\IDE\devenv.com" /setup"

您会注意到模板格式与常规 C# 文件有点不同。这允许根据不同的设置自定义模板的显示方式。 MSDN 有几个关于这些如何工作以及如何使用它们的指南：

http://msdn.microsoft.com/en-us/library/ms247113.aspx

http://msdn.microsoft.com/en-us/library/eehb4faa.aspx

http://msdn.microsoft.com/en-us/library/ms185311.aspx

【讨论】：

这个模板 zip 文件的名称是什么
我在 IDE 下没有看到任何 devenv.com 文件夹
对于 C#，有 6 个单独的模板 - Class.zip、CodeFile.zip、Interface.zip、SilverlightClass.zip、AdoNetEntityDataModelT4CodeGenCSharp.zip 和 AdoNetEntityDataModelT4SelfTrackingCodeGenCSharp.zip。你的系统上可能有更多，这些只是我的。 ItemTemplates 文件夹中还有数百个模板。
您必须从命令提示符运行该命令。 devenv.com 不是一个文件夹，它是一个 COM 可执行文件。它再次运行第一次设置，再次提取所有模板并更新缓存。

【解决方案2】：

http://blogs.msdn.com/b/sourceanalysis/archive/2008/05/25/sharing-source-analysis-settings-across-projects.aspx

http://blogs.msdn.com/b/sourceanalysis/archive/2008/05/25/managing-source-analysis-project-settings.aspx

在它们之间你是排序的；）

因此，您为项目创建一个 stylecop 设置文件（右键单击项目 -> stylecop 设置），然后将其复制到解决方案根目录中，所有项目基本上都会从中继承其 stylecop 设置。

【讨论】：

链接已损坏