metrics.xml ファイル

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

<projects_root>/config

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

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

<category catid="TotalMetricValue">

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

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

<category catid="EntityCountOverThreshold">

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

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

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

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