コンプライアンスレポートの作成
Klocwork Static Code Analysis でコンプライアンスレポートを作成できます。これは、MISRA などの業界標準に準拠している場合に、コードベースの健全性を判断する上で役立ちます。このレポートは、関係のある特定のコンプライアンスルールに現在のコードベースが合格するかどうかを識別するドキュメントを生成します。まず、以下の手順でコンプライアンスレポートツールを開きます。
- Static Code Analysis の [レポート] タブで、メニューの最下部にある [コンプライアンスレポート] をクリックします。[コンプライアンスレポート] UI が表示されます。左側のパネルでは、以前に生成したレポートにアクセスできます。右側のパネルには、レポートの生成に使用できるコントロールが表示されます。
- C や C++ などに対して、レポートを実行する分類基準を選択します。
- [ビルド] で、レポートで使用するビルドを選択します。
- [ビュー] で、レポートで使用するビューを選択します。このフィールドが空白の場合、レポートではデフォルトのビューが使用されます。
- [レポート形式] で、MISRA オプションを選択すると、MISRA 2020 ガイドライン形式でレポートを生成できます。デフォルトで、レポートには Klocwork の一般的なコンプライアンス形式が使用されます。
- [出力ファイルタイプ] で、レポートの出力タイプを選択します。デフォルトは PDF です。
- [出力ファイル名] で、レポートの名前を選択します。デフォルトでは、ファイル名は '<project_name> <指定されたビルド>' になります。
- [出力フォルダー名] で、レポートの保存場所を選択します。デフォルトは、左側のサイドバー内のコンプライアンスレポートのルートフォルダーです。
- レポートに規則違反のサマリーのみを表示するには、[サマリーのみ] を選択します。デフォルトでは、サマリーテーブルと詳しい違反/逸脱テーブルの両方がレポートに含められます。 サマリーではない完全バージョンのレポートを閲覧するには、コンプライアンスライセンスが必要です。詳細については、Klocwork カスタマーサポートにお問い合わせください。
- オプションとして、生成されたレポートに関する [欠陥制限] (レポートに含められる指摘の数) を選択します。これを増やすと、レポートのサイズと生成にかかる時間が両方とも増えることに注意してください。欠陥制限を追加すると、違反と逸脱の詳細テーブルでの指摘の数に制限が適用されるため、サマリーではない完全レポートのみに影響します。多数の逸脱を含めてサマリーではないレポートを生成する場合などに、必要に応じて使用してください。
- [生成] をクリックしてレポートをビルドします。
生成されたレポートは、左側の [レポート] パネルで確認できます。 以前に生成されたレポートを削除する場合は、そのレポートを 'projects_root/projects/custom_reports' フォルダーから削除する必要があります。
違反リストおよび逸脱リストの解釈
違反としてまたは逸脱として表示されるかは、指摘のステータスによって決まります。
レポートでは、次のタイプの指摘を違反として分類します。
- 解析
- 要修正
- 今後のリリースで要修正
- 次回のリリースで要修正
レポートでは、次のタイプの指摘を逸脱として分類します。
- 保留
- フィルター
- 無視 (Ignore)
- 問題ではない