簡単なウォークスルー: デフォルトのコード行数と複雑度レポートをカスタマイズする

簡単な例として、デフォルトのコード行数と複雑度レポートのカスタマイズをリハーサルすることができます。この例で metrics.xml ファイルに精通できるので、より複雑なカスタマイズ (独自レポートタイプの追加など) を実行できるようになります。この例では、Klocwork Static Code Analysis で変更内容が表示されることを確認する必要がある箇所についても示します。

Restriction: '複雑度' と 'サイズ' のレポート名は予約されており、使用できません。

デフォルトのコード行数と複雑度レポートをカスタマイズするには:

  1. 次のファイルをバックアップします。<projects_root>/config/metrics.xml
  2. 編集する元の metrics.xml ファイルを開きます。
  3. コード行数レポートの場合、変更できるのは、Static Code Analysis でレポートタイプリストに表示されるラベルだけです。このラベルを変更するには、<name> 要素の値を編集します (デフォルトでは 'コード行数')。

    例として、<name> 要素の値を "Lines of Code" に変更します。

    <category catid="TotalMetricValue">

    <metric>

    <name>Lines of Code</name>

    <description>Lines of Code</description>

    <!--involved kw internal metric kinds-->

    <kids>45,84</kids>

    <enable>true</enable>

    </metric>

    </category>

  4. 複雑度レポートの場合:
    • 短いタイトル (Static Code Analysis でレポートタイプリストに表示されるラベル) を変更するには、<name> 要素の値を編集します (デフォルトでは "複雑度")。
    • デフォルトしきい値 (Static Code Analysis で編集可能な [しきい値] フィールドに表示される値) を変更するには、<default_threshold> 要素の値を編集します (デフォルトでは 20)。

    例として、<default_threshold> 要素の値を 10 に変更します。

    <category catid="EntityCountOverThreshold">

    <metric>

    <name>My Complexity</name>

    <description>Method Complexity >{threshold}</description>

    <kids>135</kids>

    <entityKids></entityKids>

    <default_threshold>10</default_threshold>

    <enable>true</enable>

    </metric>

    </category>

  5. ファイルを保存します。
  6. Klocwork サーバーを kwservice restart または Windows Services 管理で再起動します。

    Static Code Analysis ユーザーがログインしたとき、または [レポート] ページを更新したときに、行った変更の内容がそれらすべてのユーザーに表示されます。変更内容が正しく表示されていることを確認します。

  7. Static Code Analysis にログインします。
  8. プロジェクトの [レポート] をクリックします。

  9. [新規レポートの作成] をクリックします。

    レポートタイプを既に表示している場合は、ブラウザーを更新して metrics.xml に変更内容を反映します。

  10. レポートタイプが右側に表示されます。下へスクロールして [もっと見る] をクリックします。

    [コード行数] レポートタイプがリストに含まれて表示されます。

  11. [複雑度] を選択します。

    これでデフォルトのしきい値は、20 ではなく 10 に設定されます。