EN JP CN

のデフォルトのレポート Klocwork Static Code Analysis

のデフォルトのレポート Klocwork Static Code Analysis

のデフォルトのレポート Klocwork Static Code Analysis

のデフォルトのレポート Klocwork Static Code Analysis

この記事では、Klocwork Static Code Analysis のデフォルトのレポートについてリファレンス情報を提供します。レポートの作成および編集方法の詳細については、Klocwork Static Code Analysis でレポートをお使いになる前にを参照してください。

注: 以前のバージョンからアップグレードした場合は、移行したレポートもレポートのツリーに含まれている可能性があります。

サマリー:

サマリーレポートはプロジェクトのダッシュボードで、プロジェクトの整合性について簡単な診断情報を提供します。サマリーレポートは次の 4 種のデフォルトのレポートを提供します。

  • 2 つのトレンド -- 解析ステータスの指摘と要修正ステータスの指摘 -- を示す更新バックログ
  • 最新ビルドの上位指摘を示す上位の指摘
  • 複雑度が 20 を超えるメソッドの数を示す複雑度トレンド
  • すべての指摘のさまざまなステート (新規、未解決、修正済み) を示すステート別の全指摘

詳細な編集可能ビューを表示するには、レポートをクリックしてください。

このレポートを編集して、他のデフォルトのレポートや作成済みレポートを追加できます。

他のレポートと同様、サマリーレポートの指摘カウントヘッダーの指摘のグループ化を有効または無効にできます (デフォルトレポートの編集はできないため、この設定を変更するにはこのレポートのコピーを作成する必要があります)。ダッシュボードに配置されるレポートのグループ化設定は、適宜、各レポートのグループ化設定から決定されます。サマリーレポートのこの設定を編集した場合、以下のようにレポートの上部に表示される指摘の数に影響があります。

指摘サマリー

カテゴリ別詳細

カテゴリ別詳細レポートは、検出された指摘がどのように分類基準やカテゴリに分散されるかを示します。

分類基準 (および該当する場合は、その分類基準のカテゴリ) ごとに、以下が表示されます。

  • 現在のプロジェクトで指摘がどのようにカテゴリ別に分布しているかを確認できるように、[エラー分布][警告分布] を示すテーブル。
  • 検出された指摘を含め、各カテゴリのほとんどの指摘 (降順にリスト) が格納されている「上位 10 ファイル/クラス」と呼ばれるテーブル。表示されるファイル/クラスの数を定義できます。

カテゴリが含まれている分類基準は、指摘の分布と上位 10 ファイル/クラスをカテゴリ別に示します。この場合は、<taxonomy_name>:<category_name> という見出しがあります。下の例は、C/C++ 分類基準の「バッファオーバーフロー」カテゴリで検出された指摘のテーブルを示しています。

カテゴリが含まれていない分類基準もあります。この場合は、分散と上位 10 が分類基準別に表示されています (たとえば MISRA C)。

カスタマイズによって組織独自のプロセスを反映したカテゴリを設定できます。統合ビルド解析用チェッカーの設定を参照してください。

カテゴリ別詳細から、以下の操作ができます。

  • 各テーブルの列見出しで並べ替える
  • テーブル内のリンクから指摘リストにアクセスして、関心のある指摘のみを表示する

前回ビルド以降の更新活動

更新活動には、前回のビルド以降に行われた指摘ステータスの変更が表示されます。

注: このレポートタイプでは指摘のグループ化は無効です。

更新活動レポートには、以下が表示されます。

  • ユーザー更新をステータス別に円グラフで示す更新サマリー。セグメントをクリックすると、ステータス別に指摘のリストにアクセスできます。
  • 長期的なユーザー更新を示す更新履歴。X 軸の期間は、選択した日付によって決まります。間隔の基準は以下のとおりです。
    • 28 日以内の日付範囲には日
    • 28 日より長く 62 日以内の範囲には週
    • 62 日より長い範囲には月
  • 特定ステータスに変更された指摘の数をテーブル形式で表すユーザー更新。バックログ列は、まだ解析ステータスにあって評価されていない指摘の数を表示します。指摘が特定のステータスに変わると、そのステータス列のみが表示されます。列見出しは並べ替えが可能で、ステータス列で "数値リンク" をクリックすると、指摘のリストが表示されます。
注: オーナーが Klocwork データベースにロードされている場合は、オーナー別にのみバックログレポートが表示されます。オーナーシップが設定されていない場合は、"オーナーなし" のラベルが付きます。オーナーシップの設定方法については、オーナー別の指摘の追跡を参照してください。

更新バックログ

更新バックログレポートには次の 2 つのトレンドが表示されます。

  • まだ「解析」ステータスにある (つまり、デベロッパーが Klocwork ステータスを使用して、それに従ってゲートしなければならない) 指摘のバックログ。このトレンドは青色で表示されます。指摘ステータスを参照してください。
  • 要修正ステータスに割り当てられただけで、まだ修正されていない指摘のバックログ。このトレンドは赤色で表示されます。
注: このレポートタイプでは指摘のグループ化は無効です。

このレポートを複数のビルドにわたって表示する場合は、最初のビルド日から最後のビルド日までのバックログトレンドが表示されます。[最後の <n> ビルド] を選択すると、現在の日付までの各ビルドの日付が表示されます。

下のテーブルのチャートは、解析と要修正バックログをオーナー別に表示しています。

このグラフに表示されている指摘は、さまざまなステートですが、修正済みです。指摘ステートを参照してください。

モジュール別の活動の修正

デフォルトの修正活動レポートでは、統合プロジェクトの欠陥の修正をモジュール別にまとめます。このレポートを編集して、デベロッパーがコードストリームへの入力を防いだ欠陥を示すことができます。

注: このレポートは、前バージョンから移行した場合は、「コンポーネント別の修正活動」と呼ぶことができます。

複数のビルドや、複数のビルドが含まれた期間を選択すると、グラフの棒にビルドがペアで表示されます。たとえば、3 のビルドが選択された場合、2 つのバーが表示されます。1 つはビルド 1 とビルド 2 の間で修正された指摘の数で、もう 1 つはビルド 2 とビルド 3 の間で修正された指摘の数です。

ビルドを 1 つだけ選択した場合、このレポートには前回のビルド以降の修正が表示されます。

修正活動レポートは以下を基準にまとめることができます。

  • オーナー (ファイル/クラスのオーナーシップが Klocwork データベースにロードされている場合)
  • モジュール

デフォルトでは、オーナー別にまとめた修正活動には、[プロジェクトサマリー] ページの [最後の 10 ビルド] のデスクトップ修正が表示されます。

修正活動レポートには、以下の数が表示されます。

  • デスクトップとシステムレベルの両方で修正されたすべての指摘
  • 統合ビルドにチェックインされる前に修正された指摘であるデスクトップ修正
  • 統合ビルド解析で検出された指摘に発生するシステム修正

指摘がデスクトップコンポーネントに表示されるだけで、統合ビルドに表示されない場合は、デベロッパーがコーディング中 (コードを統合ビルドに送る前) にデスクトップの指摘が検出されて修正されたことになります。問題がチェックイン前に修正されたため、デスクトップの修正は予防的な修正です。修正活動をデスクトップ別に表示すると、デスクトップで誰が Klocwork を使用したかがわかります。

注: Visual Studio プラグインからのデスクトップ修正はこのレポートでは表示されません。

上位 10 の未解決の指摘

デフォルトの円グラフは、検出された上位 10 個の指摘が最新ビルドにどのように分布したかを指摘タイプ別に表示します。指摘の数はオンザフライでカスタマイズできます。

セグメントをクリックすると、選択した指摘タイプの指摘リストが表示されます。

指摘トレンド

指摘トレンドレポートは、複数のビルドにわたるコード指摘の大まかなビューを提供します。タイムラインを調整すると、1 つまたは複数の特定のビルドに対象を絞ることができます。Y 軸には指摘の数が表示されます。

トレンド解析は、製品の品質と修正率を総合的に表示するので、組織の戦略、ポリシー (たとえば、スタッフのトレーニング)、MISRA C や MISRA C++ のような業界標準規格への準拠などの有効性を測ることができます。

デフォルトでは次の 3 種類の指摘トレンドレポートがあります。モジュール別未解決指摘オーナー別未解決指摘オーナー別除外指摘

未解決指摘 (モジュール別またはオーナー別) レポートは、選択したビルドの現在のステータス別に指摘の分布を表示します。

オーナー別除外指摘レポートは、選択したビルドで除外された指摘を表示します。除外された指摘とは、「無視」または「問題ではない」のステータスに設定された指摘です。

ヒント:ヒント:レポートに表示されたビルドは、クリックして、レポート下部の レポートタイムライン セクションにドラッグすると、カスタマイズできます。

メトリック

複雑度トレンド

指定した循環的複雑度しきい値を超える関数またはクラス - メソッドの数を表示します。

レポートのデフォルトの循環的複雑度しきい値は 20 です。しきい値の詳細については、システムの複雑度を参照してください。

複雑度の詳細

複雑なメソッド上位 15 のインスタンスの数と、指定した複雑度しきい値を超えるモジュールのリストを表示します。

複雑度レポートがトレンド情報を提供する一方、複雑度の詳細は、複雑度が各モジュールのしきい値を超えるメソッドの数など、最新ビルドに関する詳しい情報を提供します。

表示される情報は、選択したモジュールによって異なります。

モジュールサイズの傾向

プロジェクトまたは選択したモジュールのコード行数の合計を計算します。

プロジェクトページについて

Klocwork Static Code Analysis にログインすると、プロジェクトページが表示されます。このページから、以下の場所に移動できます。
  • レポート
  • 統合ビルド解析で検出された指摘の一覧
  • 統合ビルド解析の問題が示されている可能性があるログ
プロジェクトマネージャー/管理者の役割がある場合は、次のことができます。
  • プロジェクトの作成、編集、削除
  • プロジェクトのコードベースでのモジュールの設定
  • プロジェクトのアクセス制御 (アクセス制御が設定されている場合)
  • 解析設定 (カスタム分類基準など) およびレポートの構成