Visual StudioでFxCopアナライザーを使用する方法

「FxCopアナライザー」は、Visual Studioを利用してプログラミングを行う際におすすめのツールです。自分が作成したプログラムが.NET Frameworkの推奨コーディング標準や、現場独自のカスタムルールに則って記述されているかをチェックできます。このFxCopアナライザーについて確認していきましょう。

システム
エンジニア

FxCopアナライザーってはじめて聞きました。簡単にいうとどのようなツールなのでしょうか？

プロジェクト
リーダー

作成したプログラムが、.NETが推奨する規約に準拠しているかどうかを自動でチェックしてくれるツールです。なので、導入する価値はあるかと思いますよ。

FxCopアナライザーの概要

FxCopアナライザーは、マイクロソフトが提供している無料のコーディング自動チェックツールです。正確には.NETアセンブリをチェックします。これは言い換えれば、コンパイル後のプログラムに対してチェックをするということです。

そのため、.NET Frameworkで動作可能な言語であるC#やVB.NETなど、各言語固有のルールに則ってチェックを行う必要がありません。FxCopアナライザー1つだけの導入でチェックが可能です。FxCopアナライザーは、現場独自のカスタムルールも設定して使用することも可能で、チェックの工数を削減できる現場の開発者からすれば、非常にありがたいツールとなることでしょう。

FxCopインストールと使用例

インストール手順
ここからは実際に、FxCopアナライザーをインストールしてみましょう。

1. 1. Visual Studioのソリューションエクスプローラーにあるプロジェクト名で右クリック→「NuGetパッケージの管理」をクリックします。
   2. 参照タブを開き、検索フィールドで「FxCopAnalyzers」を入力します。

1. 1. 「インストールボタン」を押下しインストールが実施されると、以下の画面が表示されます。「同意する」ボタンを押下してください。

1. 1. インストールが正常に終了すると、参照以下にアナライザーが追加されています。

使用例
早速コンパイルを実施してみましょう。Visual Studioのエラー一覧を開きます。
ツールの列を確認しましょう。警告ですが、今回追加したアナライザーである「Microsoft.NetCore.CSharp.Analyzers」と「Microsoft.NetCore.Analyzers」が確認できました。

システム
エンジニア

この前先輩に「社内のコーディング規約に違反しているぞ」って指摘を受けました。そういったミスを減らすためにも、FxCopアナライザーのカスタムルールを設定してみます。

プロジェクト
リーダー

そうですね。使えるツールはどんどん活用してみましょう。自分で活用してみて分かることもありますからね。

FxCopアナライザーを導入してプログラムの質を向上させましょう

どこの現場にも開発標準となるコーディング規約はあるかと思います。コーディング規約に沿ってプログラミングをしているつもりでも、人間が作成しているからには規約違反のミスはつきものです。FxCopアナライザーはカスタムルールも設定できますので、規約違反を見つけるには最適なツールといえるでしょう。