代码分析工具使用准则

更新：2007 年 11 月

下面的列表提供了几条准则，以帮助您选择和管理代码分析警告。

建议

• 检查警告类别。

  由于代码分析工具针对代码缺陷执行广泛的检查，因此对不同的警告有基本了解是很有用的。有关警告类别的更多信息，请参见 托管代码的代码分析警告 或 C/C++ 代码分析警告。

• 分析现有代码。

  根据您的项目类型、资源和要求，选择最符合您的需要的方法。

  • 启用所有警告。

    启用所有警告，然后检查由分析工具生成的警告列表，以确定您要启用的警告。

  • 启用警告子集。

    检查警告类别，以决定要在您的项目中使用的警告子集，并仅启用那些警告。

• 在开发期间分析代码。

  由于您并不是处理现有代码，因此建议您在整个开发期间启用所有警告并分析代码中的缺陷。在开发期间分析和修复代码要容易的多。不要等到开发周期结束时才分析代码或启用许多警告。这可能会给小组成员带来不必要的压力，并且可能危害代码的安全和稳定性。

• 跟踪警告。

  决定要在您的项目中使用的警告之后，使用工作跟踪功能来跟踪它们。有关更多信息，请参见如何：添加新工作项。

• 修复警告。

  有几种方法可以修复警告：

  • 更正 - 在签入代码之前修复并测试代码。

  • 禁止显示 - 您可以使用托管代码中的 System.Diagnostics.CodeAnalysis.SuppressMessageAttribute 属性在特定位置禁止显示由代码导致生成的警告。

  • 禁用 - 您可以使用项目属性页来禁用所有托管代码的警告。对于 C/C++，您可以使用列出所有警告的头文件。使用该文件来启用或禁用对于您的项目并非必要的警告。

  修复警告之后，将其状态从警告更改为错误。这有助于使您的代码保持干净。

• 指定签入要求。

  您可以设置代码签入策略，要求将代码分析作为签入策略的一部分运行。只允许签入通过分析的代码。这将有助于确保签入的代码是干净的。有关签入策略的更多信息，请参见 代码分析签入策略。