コード分析による品質向上のキモ - VSTDにおけるFxCopツール活用 -

Visual Studio 2005 Team Edition for Software Developersを使ってみよう （2）

SuppressMessageを使って除外の設定をしよう

　さて、このようにルールを適用してコーディングを進めていったとします。しかし、どうしても一部分だけコード分析のルールを除外したいがルールを変更するわけにはいかない、という場合もあると思います。例えば規約CA1705の｢長い頭字語の場合は、Pascal形式で大文字/小文字を使い分けます｣を適用していたとします。この規約では｢DB～｣というクラス名は使用できますが｢XML～｣というクラス名は作成できません。しかしどうしても｢XML～｣というクラス名が作りたい時、VSTDでは、UIからマウスクリックだけでルール適用の例外の設定を行う事ができます。ビルドを行った後、エラー一覧の画面から除外したいエラーを右クリックし、「メッセージの非表示」を選択します（図6）。設定を行うと図7にあるように対象のエラーに取り消し線が引かれて表示されます。さらに次回以降のビルドからはエラーが表示されなくなります。

図6 除外の設定画面

図7 除外の設定の適用画面

　内部で何が行われているかですが、メソッドやクラスが規約違反の対象だった場合は対象のコードに

[System.Diagnostics.CodeAnalysis.SuppressMessage(
"Microsoft.Performance", "CA1804:RemoveUnusedLocals"]

　といった属性が追加されます。このSuppressMessageはコード分析を除外するための属性で、1つ目の引数には対象の規則、2つ目の引数には対象の規約が記述されています。SuppressMessage属性は一つのメソッドに対して複数適用することもできます。またアセンブリや名前空間が規約違反の場合はグローバル抑制ファイルが自動生成され、SuppressMessageの情報が記載されます（図8）。

図8 自動生成されたグローバル抑制ファイル

　いずれにしても例外を安易に作らないよう、どうしても例外を設定しなければならない時だけ使用してください。

まとめ

　コード分析について基本的な使い方と例外の設定方法、TFSとの連携について説明させて頂きました。コード分析は200種類以上の豊富な規約を持ち、例外を設定できたりと実際の使用もよく考えられた機能となっています。コード分析をうまく使用することでソフトウェアの品質向上が望めるんじゃないかという感想をお持ちいただけなのではないでしょうか。本稿がコード分析導入を考える際の検討材料になれば幸いです。

参考資料

1. Visual Studio 2005 Team System ホームページ
2. MSDN Library - Visual Studio Team Systemドキュメント