コード分析

  • [アーティクル]

コード アナライザーを使用すると、.NET Framework アプリケーション コードの潜在的な問題を見つけることができます。 アナライザーによって、潜在的な問題が検出され、その修正が提案されます。

コードを書くとき、あるいは CI ビルドの一部として、Roslyn ベースのコード アナライザーは、Visual Studio で対話的に動作します。 開発サイクルのできるだけ早い段階で、プロジェクトにアナライザーを追加する必要があります。 コードに潜む問題を見つけるのが早ければ早いほど、修正が簡単になります。 アナライザーによって、既存のコードの問題にフラグが設定され、開発を続けると、新しい問題に関する警告が表示されます。

Note

この記事では、非推奨となった Microsoft.NetFramework.Analyzers NuGet パッケージを使用します。 .NET 5 以降、NET アナライザーは .NET SDK に含められています。 必要に応じて、Microsoft.CodeAnalysis.NetAnalyzers NuGet パッケージを代わりに使用できます。 詳細については、.NET でのコード分析に関する記事を参照してください。

アナライザーのインストールと構成

.NET Framework Analyzer は Microsoft.NetFramework.Analyzers NuGet パッケージで配布されます。 このパッケージには、.NET Framework API に固有のアナライザーが用意されており、これにはセキュリティ アナライザーが含まれています。 このパッケージは Microsoft.CodeAnalysis.FxCopAnalyzers パッケージに含まれているので、パッケージをインストールする場合は、.NET Framework アナライザーを個別にインストールする必要はありません。

アナライザーを実行するすべてのプロジェクトに NuGet パッケージをインストールします。 1 人の開発者がそれをプロジェクトに追加すれば十分です。 アナライザー パッケージはプロジェクト依存関係であり、更新済みのソリューションが与えられると、あらゆる開発者のコンピューターで実行されます。

このパッケージをインストールするには、プロジェクトを右クリックし、[依存関係の管理] を選択します。 NuGet エクスプローラーで、"Microsoft.NetFramework.Analyzers" を検索します。 ソリューションのすべてのプロジェクトで安定した最新のバージョンをインストールします。

アナライザーの使用

NuGet パッケージがインストールされたら、ソリューションをビルドします。 アナライザーは、コードベースで見つかった問題を報告します。 問題は Visual Studio の [エラー一覧] ウィンドウに警告として表示されます。次の画像をご覧ください。

Issues reported by .NET Framework analyzers.

コードを記述しているとき、コードに潜在的な問題があれば、その部分に波線が表示されます。 次の画像に示すように、問題をポイントすると、詳細情報が表示され、考えられる修正候補が表示されます。

Interactive report of issues found by code analyzers.

詳細については、Visual Studio のコード分析に関するページを参照してください。

規則の種類

アナライザーによって、ソリューション内のコードが検査され、CA プレフィックスと共に警告が表示されます。 可能性のあるすべての警告の一覧については、「コード品質規則」を参照してください。 .NET Framework の API に適用されるのは、次のような一部の警告のみです。

関連項目