EN JP CN

metrics.xml ファイル

metrics.xml ファイル

メトリックレポート構成ファイル (metrics.xml) は、Klocwork Static Code Analysis で報告されるメトリックを定義します。metrics.xml ファイルは、次の場所にあります。

<projects_root>/config

重要:メトリックレポート構成ファイルの変更を行う前に、バックアップしてください。

メトリックレポートは、次の <category> タグのいずれかでカスタマイズすることができます。

<category catid="TotalMetricValue">

所定モジュールのコード行数など、指定メトリックの合計値を報告します。

重要:TotalMetricValue は、File/Class メトリックだけを使用することができます (Function/Method メトリックではありません)。

<category catid="EntityCountOverThreshold">

値が所定のメトリックのしきい値を超えるエンティティの数を報告します。 たとえば、循環的複雑度が 20 を超えるメソッド数です。

各 <metric> 要素は、1 つのメトリックレポートを定義します。デフォルトレポートの値を編集して、複数の <metric> セクションを作成することで、複数のカスタムメトリクスレポートを各カテゴリに追加することができます。

カスタマイズが必要となる場合がある <metric> 要素の下位要素は次のとおりです。

要素 目的
<name>Static Code Analysis に表示されるレポートの短い名前。
<description>Static Code Analysisでレポート最上部に表示される詳細なタイトル。注意:レポートタイトルにしきい値を含める場合、プレースホルダーとして {threshold} を使用することができます。Klocwork によりしきい値に置換されます。
<custom_metric_names>ユーザーが定義するメトリックに基づくカスタムレポートを追加するために使用されます (Klocwork メトリックとは対照的です)。.umeファイルからの 1 つ以上のメトリック (<metric_name> フィールドの値)。
<kids>Klocwork メトリックに基づくカスタムレポートを追加するために使用されます (ユーザーが定義するメトリックとは対照的です)。EntityCountOverThreshold とTotalMetricValue の両方に対して、Klocwork メトリック ID を使用します。メトリック ID はメトリックリファレンスで確認することができます。参照項目:
<entityKids>EntityCountOverThreshold レポート限定。数える Klocwork エンティティの種類のリスト。取り得る値のリストについては、サポートされているエンティティタイプ を参照してください。C/C++ ファイルおよび Java クラスを表現するための一般的な値:1,46 C/C++ 関数および Java メソッドを表現するための一般的な値:5,48
<default_threshold>EntityCountOverThreshold レポート限定。しきい値のデフォルト値。デフォルトしきい値がこのタグで指定されていない場合、値 20 が使用されます。注意: Static Code Analysisユーザーはしきい値をリセットすることができます。
<enable>メトリックを 偽 に設定することで、無効にします。 有効にするには、真 に設定します。