コードメトリックスデータの生成

[アーティクル]
09/07/2023

コードメトリックデータは、次の 3 つの方法で生成できます。

.NET コード品質アナライザーを有効化し、それに含まれている 4 つのコードメトリック (保守性) ルールを有効化します。
Visual Studio で [分析]>[コードメトリックスの計算] メニューコマンドを選択します。
C# および Visual Basic プロジェクトではコマンドラインから。

.NET コード品質アナライザーのコードメトリックルール

.NET コード品質アナライザーには、コードメトリックアナライザールールがいくつか含まれています。

これらの規則は既定では無効ですが、ソリューションエクスプローラーまたは EditorConfig ファイルで有効にすることができます。たとえば、ルール CA1502 を警告として有効にするには、EditorConfig ファイルに次のエントリを含めます。

dotnet_diagnostic.CA1502.severity = warning

構成

コードメトリックルールが起動されるしきい値を構成できます。

テキストファイルを作成します。たとえば、CodeMetricsConfig.txt という名前を付けます。
必要なしきい値を次の形式でこのテキストファイルに追加します。
```
CA1502: 10
```
この例では、メソッドのサイクロマティック複雑度が 10 を超えると、ルール CA1502 が起動するように構成されます。
Visual Studio の [プロパティ] ウィンドウまたはプロジェクトファイルで、構成ファイルのビルドアクションを AdditionalFiles としてマークします。たとえば次のような点です。
```
<ItemGroup>
  <AdditionalFiles Include="CodeMetricsConfig.txt" />
</ItemGroup>
```

[分析]>[コードメトリックスの計算] メニューを使用して、IDE で開いているプロジェクトの 1 つまたはすべてのコードメトリックを生成します。

ソリューション全体のコードメトリック結果を生成する

ソリューション全体に対するコードメトリック結果は、次のいずれかの方法で生成できます。

メニューバーで、[分析]>[コードメトリックスの計算]>[ソリューション用] を選択します。
ソリューションエクスプローラーでソリューションを右クリックし、[コードメトリックスの計算] を選択します。
[コードメトリックスの結果] ウィンドウで、[ソリューションのコードメトリックスを計算] ボタンを選択します。

結果が生成され、[コードメトリックスの結果] ウィンドウが表示されます。結果の詳細を表示するには、[階層] 列でツリーを展開します。

1 つ以上のプロジェクトのコードメトリック結果を生成する

ソリューションエクスプローラーで、1 つ以上のプロジェクトを選択します。
メニューバーで、[分析]>[コードメトリックスの計算]>[選択したプロジェクト用] を選択します。

結果が生成され、[コードメトリックスの結果] ウィンドウが表示されます。結果の詳細を表示するには、[階層] のツリーを展開します。

コマンドラインコードメトリック

.NET Framework、.NET Core、および .NET Standard アプリの C# および Visual Basic プロジェクトでは、コマンドラインからコードメトリックデータを生成できます。コマンドラインからコードメトリックを実行するには、Microsoft.CodeAnalysis.Metrics NuGet パッケージをインストールするか、Metrics.exe 実行可能ファイルを自らビルドします。

Microsoft.CodeAnalysis.Metrics NuGet パッケージ

コマンドラインからコードメトリックデータを生成する最も簡単な方法は、Microsoft.CodeAnalysis.Metrics NuGet パッケージをインストールすることです。パッケージをインストールしたら、プロジェクトファイルが格納されているディレクトリで msbuild /t:Metrics を実行します。たとえば次のような点です。

C:\source\repos\ClassLibrary3\ClassLibrary3>msbuild /t:Metrics
Microsoft (R) Build Engine version 16.0.360-preview+g9781d96883 for .NET Framework
Copyright (C) Microsoft Corporation. All rights reserved.

Build started 1/22/2019 4:29:57 PM.
Project "C:\source\repos\ClassLibrary3\ClassLibrary3\ClassLibrary3.csproj" on node 1 (Metrics target(s))
.
Metrics:
  C:\source\repos\ClassLibrary3\packages\Microsoft.CodeMetrics.2.6.4-ci\build\\..\Metrics\Metrics.exe /project:C:\source\repos\ClassLibrary3\ClassLibrary3\ClassLibrary3.csproj /out:ClassLibrary3.Metrics.xml
  Loading ClassLibrary3.csproj...
  Computing code metrics for ClassLibrary3.csproj...
  Writing output to 'ClassLibrary3.Metrics.xml'...
  Completed Successfully.
Done Building Project "C:\source\repos\ClassLibrary3\ClassLibrary3\ClassLibrary3.csproj" (Metrics target(s)).

Build succeeded.
    0 Warning(s)
    0 Error(s)

出力ファイル名をオーバーライドするには、/p:MetricsOutputFile=<filename> を指定します。また、/p:LEGACY_CODE_METRICS_MODE=true を指定して、以前のスタイルのコードメトリックデータを取得することもできます。たとえば次のような点です。

C:\source\repos\ClassLibrary3\ClassLibrary3>msbuild /t:Metrics /p:LEGACY_CODE_METRICS_MODE=true /p:MetricsOutputFile="Legacy.xml"
Microsoft (R) Build Engine version 16.0.360-preview+g9781d96883 for .NET Framework
Copyright (C) Microsoft Corporation. All rights reserved.

Build started 1/22/2019 4:31:00 PM.
The "MetricsOutputFile" property is a global property, and cannot be modified.
Project "C:\source\repos\ClassLibrary3\ClassLibrary3\ClassLibrary3.csproj" on node 1 (Metrics target(s))
.
Metrics:
  C:\source\repos\ClassLibrary3\packages\Microsoft.CodeMetrics.2.6.4-ci\build\\..\Metrics.Legacy\Metrics.Legacy.exe /project:C:\source\repos\ClassLibrary3\ClassLibrary3\ClassLibrary3.csproj /out:Legacy.xml
  Loading ClassLibrary3.csproj...
  Computing code metrics for ClassLibrary3.csproj...
  Writing output to 'Legacy.xml'...
  Completed Successfully.
Done Building Project "C:\source\repos\ClassLibrary3\ClassLibrary3\ClassLibrary3.csproj" (Metrics target(s)).

Build succeeded.
    0 Warning(s)
    0 Error(s)

コードメトリックの出力

生成される XML 出力の形式は次のとおりです。

<?xml version="1.0" encoding="utf-8"?>
<CodeMetricsReport Version="1.0">
  <Targets>
    <Target Name="ConsoleApp20.csproj">
      <Assembly Name="ConsoleApp20, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null">
        <Metrics>
          <Metric Name="MaintainabilityIndex" Value="100" />
          <Metric Name="CyclomaticComplexity" Value="1" />
          <Metric Name="ClassCoupling" Value="1" />
          <Metric Name="DepthOfInheritance" Value="1" />
          <Metric Name="SourceLines" Value="11" />
          <Metric Name="ExecutableLines" Value="1" />
        </Metrics>
        <Namespaces>
          <Namespace Name="ConsoleApp20">
            <Metrics>
              <Metric Name="MaintainabilityIndex" Value="100" />
              <Metric Name="CyclomaticComplexity" Value="1" />
              <Metric Name="ClassCoupling" Value="1" />
              <Metric Name="DepthOfInheritance" Value="1" />
              <Metric Name="SourceLines" Value="11" />
              <Metric Name="ExecutableLines" Value="1" />
            </Metrics>
            <Types>
              <NamedType Name="Program">
                <Metrics>
                  <Metric Name="MaintainabilityIndex" Value="100" />
                  <Metric Name="CyclomaticComplexity" Value="1" />
                  <Metric Name="ClassCoupling" Value="1" />
                  <Metric Name="DepthOfInheritance" Value="1" />
                  <Metric Name="SourceLines" Value="7" />
                  <Metric Name="ExecutableLines" Value="1" />
                </Metrics>
                <Members>
                  <Method Name="void Program.Main(string[] args)" File="C:\source\repos\ConsoleApp20\ConsoleApp20\Program.cs" Line="7">
                    <Metrics>
                      <Metric Name="MaintainabilityIndex" Value="100" />
                      <Metric Name="CyclomaticComplexity" Value="1" />
                      <Metric Name="ClassCoupling" Value="1" />
                      <Metric Name="SourceLines" Value="4" />
                      <Metric Name="ExecutableLines" Value="1" />
                    </Metrics>
                  </Method>
                </Members>
              </NamedType>
            </Types>
          </Namespace>
        </Namespaces>
      </Assembly>
    </Target>
  </Targets>
</CodeMetricsReport>

Metrics.exe

NuGet パッケージをインストールしない場合は、Metrics.exe 実行可能ファイルを生成して直接使用することができます。 Metrics.exe 実行可能ファイルを生成するには:

dotnet/roslyn-analyzers リポジトリを複製します。
管理者として Visual Studio 用開発者コマンドプロンプトを開きます。
roslyn-analyzers リポジトリのルートで、次のコマンドを実行します: Restore.cmd
src\Tools\Metrics ディレクトリに移動します。
次のコマンドを実行して、Metrics.csproj プロジェクトをビルドします。
```
msbuild /m /v:m /p:Configuration=Release Metrics.csproj
```
Metrics.exe という名前の実行可能ファイルが、リポジトリのルートの artifacts\bin ディレクトリに生成されます。

Metrics.exe の使用方法

Metrics.exe を実行するには、プロジェクトまたはソリューションと出力 XML ファイルを引数として指定します。たとえば次のような点です。

C:\>Metrics.exe /project:ConsoleApp20.csproj /out:report.xml
Loading ConsoleApp20.csproj...
Computing code metrics for ConsoleApp20.csproj...
Writing output to 'report.xml'...
Completed Successfully.

レガシモード

"レガシモード" での Metrics.exe のビルドを選択できます。ツールのレガシモードバージョンでは、以前のバージョンのツールで生成されたものに近いメトリック値が生成されます。また、レガシモードでは、以前のバージョンのツールでコードメトリック生成が行われたのと同じ一連のメソッドのタイプに対して、Metrics.exe によってコードメトリックが生成されます。たとえば、フィールドやプロパティ初期化子のコードメトリックデータは生成されません。レガシモードは、旧バージョンとの互換性を維持したり、コードメトリックの数値に基づいてコードチェックインゲートを用意したりする場合に便利です。レガシモードで Metrics.exe をビルドするコマンドは次のとおりです。

msbuild /m /v:m /t:rebuild /p:LEGACY_CODE_METRICS_MODE=true Metrics.csproj

詳細については、「レガシモードでのコードメトリック生成の有効化」を参照してください。

以前のバージョン

Visual Studio 2015 には、Metrics.exe とも呼ばれるコマンドラインコードメトリックツールが含まれていました。このツールの以前のバージョンでは、バイナリ分析 (アセンブリベースの分析) が行われていました。新しいバージョンの Metrics.exe ツールでは、代わりにソースコードが分析されます。新しい Metrics.exe ツールはソースコードに基づいているため、コマンドラインコードメトリックの結果が、Visual Studio IDE および以前のバージョンの Metrics.exe によって生成されたものと異なる場合があります。 Visual Studio 2019 以降では、Visual Studio IDE はコマンドラインツールのようにソースコードを分析し、結果は同じになります。

新しいコマンドラインコードメトリックツールでは、ソリューションとプロジェクトを読み込むことができる限り、ソースコードエラーが存在する場合でもメトリックを計算します。

メトリック値の違い

Starting in Visual Studio 2019 バージョン 16.4 以降および Microsoft.CodeAnalysis.Metics (2.9.5) では、SourceLines および ExecutableLines によって以前の LinesOfCode メトリックが置き換えられます。新しいメトリックの詳細については、「コードメトリックの値」を参照してください。この LinesOfCode メトリックは、レガシモードで使用できます。

CyclomaticComplexity や MaintainabilityIndex など他のメトリックでは、以前のバージョンの Metrics.exe と同じ数式が使用されますが、新しいツールでは中間言語 (IL) 命令ではなく IOperations (論理ソース命令) の数がカウントされます。これらの数は、Visual Studio IDE および以前のバージョンの Metrics.exe によって生成される数とは若干異なります。

次の方法で共有

コードメトリックスデータの生成

.NET コード品質アナライザーのコードメトリックルール

構成

[コードメトリックスの計算] メニューコマンド

ソリューション全体のコードメトリック結果を生成する

1 つ以上のプロジェクトのコードメトリック結果を生成する

コマンドラインコードメトリック

Microsoft.CodeAnalysis.Metrics NuGet パッケージ

コードメトリックの出力

Metrics.exe

Metrics.exe の使用方法

レガシモード

以前のバージョン

メトリック値の違い

フィードバック

その他のリソース

次の方法で共有

コード メトリックス データの生成

.NET コード品質アナライザーのコード メトリック ルール

構成

[コード メトリックスの計算] メニュー コマンド

ソリューション全体のコード メトリック結果を生成する

1 つ以上のプロジェクトのコード メトリック結果を生成する

コマンド ライン コード メトリック

Microsoft.CodeAnalysis.Metrics NuGet パッケージ

コード メトリックの出力

Metrics.exe

Metrics.exe の使用方法

レガシ モード

以前のバージョン

メトリック値の違い

関連するコンテンツ

フィードバック

その他のリソース

コードメトリックスデータの生成

.NET コード品質アナライザーのコードメトリックルール

[コードメトリックスの計算] メニューコマンド

ソリューション全体のコードメトリック結果を生成する

1 つ以上のプロジェクトのコードメトリック結果を生成する

コマンドラインコードメトリック

コードメトリックの出力

レガシモード