ここでは、コード分析から生成される警告を選択したり、管理したりするための、さまざまなガイドラインを紹介します。
推奨
警告のカテゴリを再確認する。
コード分析ツールでは、コード障害を検出するために、さまざまなチェックが実行されるため、各種の警告についての基本的な理解が必要です。 警告のカテゴリの詳細については、「マネージ コードの警告に対応するコードの解析」または「C/C++ コードの警告に対応するコードの分析」を参照してください。
既存のコードを分析する。
プロジェクトの種類、リソース、および要件に応じて、各自のニーズに最適のアプローチを選択してください。
すべての警告を有効にする。
まず、すべての警告を有効にし、分析ツールによって生成された一連の警告を確認してから、有効にする警告を判断するようにします。
一部の警告を有効にする。
警告のカテゴリを再確認した上で、プロジェクトに使用する警告の種類を選択し、必要な警告だけを有効にするようにします。
開発中にコードを分析する。
既存のコードを扱っているわけではないので、すべての警告を有効にし、開発期間を通じて、コード障害を分析することをお勧めします。 コードの分析と修正は、開発段階に行った方がはるかに簡単です。 開発サイクルの終わりを待たずにコードを分析すること、また、さまざまな警告を有効にすることを心がけてください。 そうしないと、チーム メンバーに不要な負担が生じるだけでなく、コードのセキュリティと信頼性まで損なわれる場合があります。
警告を追跡する。
プロジェクトで使用する警告を有効にしたら、作業の追跡機能を使って、それらを追跡します。 詳細については、次のトピックを参照してください。
警告に対処する。
警告は、次のいずれかの方法で修正できます。
修正: コードを修正し、テストしてからチェックインします。
抑制: マネージ コードでは、特定箇所のコードに対して生成される警告を、System.Diagnostics.CodeAnalysis.SuppressMessageAttribute 属性を使用して抑制できます。
無効化: すべてのマネージ コードでは、プロジェクトのプロパティ ページを使用して警告を無効にできます。 C/C++ の場合、すべての警告を列挙したヘッダー ファイルを使用できます。 このファイルを使用して、警告を有効にしたり、プロジェクトで不要な警告を無効にしたりできます。
このように警告に対処した後、そのステータスを警告からエラーに変更します。 これにより、コードをクリーンな状態に維持できます。
チェックイン要件を指定する。
コードのチェックイン ポリシーを設定する際、コード分析を実行してからチェックインするようにできます。 分析に合格したコードのみが、チェックインできます。 これにより、チェックインされているコードがクリーンな状態であることを確認できます。 チェックイン ポリシーの詳細については、「コード分析を用いたチェックイン ポリシーの作成と使用」を参照してください。