对托管代码实施自定义代码分析签入策略

代码分析签入策略指定一组规则,在将源代码签入到版本控制之前,团队项目的成员必须对源代码运行这些规则。 Microsoft 提供一组将代码分析规则分为若干个功能区域的标准“规则集”。 “自定义签入策略规则集”指定一组特定于团队项目的代码分析规则。 规则集存储在 .ruleset 文件中。

签入策略是在团队项目级别设置的,并由版本控制树中 .ruleset 文件的位置来指定。 团队策略自定义规则集的版本控制位置并无限制。

在每个项目的属性窗口中可以为单个代码项目配置代码分析。 代码项目的自定义规则集由本地计算机上 .ruleset 文件的物理位置来指定。 如果所指定的 .ruleset 文件位于代码项目所在的驱动器上,则 Visual Studio 2010 使用项目配置中文件的相对路径。

创建团队项目自定义规则集的建议做法是,将签入策略 .ruleset 文件存储在不属于任何代码项目的特殊文件夹中。 如果将文件存储在专用文件夹中,则可以应用权限来限制哪些人可以编辑规则文件,并可以将包含项目的目录结构轻松移到另一目录或计算机。

创建团队项目自定义签入规则集

若要创建团队项目的自定义规则集,请首先在**“源代码管理资源管理器”**中为签入策略规则集创建特殊文件夹。 然后创建规则集文件并将该文件添加到版本控制。 最后,将规则集指定为团队项目的代码分析签入策略。

提示

若要在团队项目中创建文件夹,首先必须将团队项目根目录映射到本地计算机的某个位置。 有关更多信息,请参见创建和使用工作区

为签入策略规则集创建版本控制文件夹

  1. 在团队资源管理器中,展开“团队项目”节点,然后单击**“源代码管理”**。

  2. 在**“文件夹”窗格中,右击团队项目,然后单击“新建文件夹”**。

  3. 在主“源代码管理”窗格中,右击**“新建文件夹”,单击“重命名”**,然后键入规则集文件夹的名称。

创建签入策略规则集

  1. 在**“文件”菜单上指向“新建”,然后单击“文件”**。

  2. 在**“类别”列表中单击“常规”**。

  3. 在**“模板”列表中双击“代码分析规则集”**。

  4. 指定要包括在规则集中的规则,然后将规则集文件保存到所创建的规则集文件夹中。

    有关更多信息,请参见创建自定义代码分析规则集

将规则集文件添加到版本控制中

  1. 在**“源代码管理资源管理器”中,右击新文件夹,然后单击“将项添加到文件夹”**。

    有关更多信息,请参见 使用版本控制

  2. 单击所创建的规则集文件,然后单击**“完成”**。

    该文件将添加到源代码管理中并签出给您。

  3. 在**“源代码管理资源管理器”详细信息窗口中,右击该文件名,然后单击“签入挂起的更改”**。

  4. 在**“签入”对话框中,可以选择添加注释,然后单击“签入”**。

    提示

    如果已为团队项目配置了代码分析签入策略,并且已选择了“执行签入以只包含属于当前解决方案的文件”,则将触发策略失败警告。 在“策略失败”对话框中,选择“重写策略失败并继续签入”。 添加所需注释,然后单击“确定”

将规则集文件指定为签入策略

  1. 在**“团队”菜单中,指向“团队项目设置”,然后单击“源代码管理”**。

  2. 单击**“签入策略”,然后单击“添加”**。

  3. 在**“签入策略”列表中,双击“代码分析”,确保选中“对托管代码执行代码分析”**复选框。

  4. 在**“运行此规则集”列表中,单击“<从源代码管理选择规则集>”**。

  5. 键入签入策略规则集文件在版本控制中的路径。

    路径必须符合以下语法:

    **$/TeamProjectName/**VersionControlPath

    提示

    可以在“源代码管理资源管理器”中使用以下过程之一复制路径:

    • 在**“文件夹”窗格中,单击包含规则集文件的文件夹。 复制“源”**框中出现的文件夹的版本控制路径,并手动键入规则集文件的名称。

    • 在详细信息窗口中,右击规则集文件,然后单击**“属性”。 在“常规”选项卡上,复制“服务器名称”**中的值。

将代码项目同步到签入策略规则集

在代码项目的属性对话框中,将团队项目签入策略规则集指定为代码项目配置的代码分析规则集。 如果规则集与代码项目位于同一驱动器上,则从文件对话框中选择相对路径时使用该路径指定规则集。 通过使用相对路径,可以将项目属性设置移植到使用类似本地版本控制结构的其他计算机上。

将团队项目规则集指定为代码项目的规则集

  1. 如有必要,从版本控制中检索签入策略规则集文件夹和文件。

    可以在**“源代码管理资源管理器”中执行此步骤,方法是右击规则集文件夹,然后单击“获取最新版本”**。

  2. 在**“解决方案资源管理器”中右击代码项目,然后单击“属性”**。

  3. 单击**“代码分析”**。

  4. 如有必要,在**“配置”“平台”**列表中,单击适当的选项。

  5. 若要在每次使用指定配置生成代码项目时运行代码分析,请选中**“生成时启用代码分析(定义 CODE_ANALYSIS 常量)”**复选框。

  6. 若要忽略其他公司的组件中的代码,请选中**“取消显示由生成代码产生的结果”**复选框。

  7. 在**“运行此规则集”列表中,单击“<浏览...>”**。

  8. 指定签入策略规则集文件的本地版本。