Polyspace Access でのバグ修正または正当化による結果への対処

このトピックでは、Polyspace^® Access™ Web インターフェイスで Polyspace の結果にレビュー情報を追加する方法を説明します。Polyspace デスクトップ製品のユーザーインターフェイスでの同様のワークフローについては、Polyspace ユーザーインターフェイスでのバグ修正または正当化による結果への対処 (Polyspace Bug Finder)を参照してください。

Polyspace 検出の根本原因を理解したら、コードを修正できます。そうしない場合は、Polyspace の結果にレビュー情報を追加して、後でコードを修正するか、結果を正当化します。この情報を使用して、レビューの進行状況を追跡できます。

結果ファイルにレビュー情報を追加する場合、そのレビュー情報は同じプロジェクトの次回の解析に引き継がれます。同じ情報をコメントとしてコードに追加する (注釈を付ける) 場合、それらは同じプロジェクトかどうかにかかわらず、そのコードの以降の解析に引き継がれます。

[結果の詳細] ペインでのレビュー情報の追加

[ステータス] と [重大度] を設定し、必要に応じて [結果の詳細] ペインで詳細な説明を含むメモを入力します。ステータスは、Polyspace の結果に対する応答を示します。

結果に対する応答としてコードを修正する予定がない場合は、以下のいずれかのステータスを割り当てます。

正当化済み
アクションの予定なし
欠陥ではない

これらのステータスは、十分な検討のうえで結果が正当化された (結果にもかかわらずコードが保持された) ことを示します。以降の解析では、以前と同様に正当化された結果が引き続き表示されることに注意してください。たとえば、Code Prover で以前はオレンジだった結果が、正当化の後で緑になることはありません。ただしレビューの段階で、正当化された結果を 1 回のクリック操作によってフィルターで除外し、正当化されていない結果のみに集中することができます。Polyspace Access Web インターフェイスでの結果のフィルタリングと並べ替えを参照してください。

Polyspace Test™ 結果は [正当化済み] ステータスを継承できます。親ノードに [正当化済み] ステータスを割り当てると、その親ノードのすべての子ノードがこのステータスを継承します。[結果の詳細] ペインでは、[正当化済み] ステータスを継承した子ノードに [継承] というラベルが表示されます。

Polyspace Access プロジェクトでのカスタムステータスの追加

会社で結果にカスタムレビューステータスを使用する場合は、Polyspace Access でそのカスタムレビューステータスを追加します。カスタム [ステータス] を追加するには、次のようにします。

Polyspace デスクトップインターフェイスで結果を開きます。デスクトップインターフェイスで Polyspace Access の結果を開くを参照してください。
Polyspace デスクトップインターフェイスでカスタムステータスを作成します。カスタムレビューステータスの作成 (Polyspace Bug Finder)を参照してください。

作成したステータスは、[結果の詳細] ペインの [ステータス] ドロップダウンで使用可能になります。そのカスタムステータスは、Polyspace Access または Polyspace デスクトップインターフェイスから割り当てることができます。

カスタムステータスを調査結果に割り当てたら、同じプロジェクト内の他の調査結果にもそのステータスを適用できます。カスタムステータスを他のプロジェクトの調査結果に割り当てることはできません。

レビュー進行状況の追跡

レビューワークフローを容易にするために、Polyspace Access では解析の調査結果が次のように分類されます。

[要処理] — ステータスが [未確認] で、修正または正当化によって対処する必要がある調査結果。
[処理中] — ステータスが [修正予定]、[調査予定]、または [その他] で、修正または正当化によって対処する必要がある調査結果。
[完了] — ステータスが [正当化済み]、[アクションの予定なし]、または [欠陥ではない] の調査結果。

メモ

グリーンの実行時チェック、グリーンの共有変数、非共有変数、およびコードメトリクスは、対処または正当化する必要はありません。これらの調査結果は、[要処理]、[処理中]、および [完了] の調査結果の数にカウントされません。

[ダッシュボード] パースペクティブでは、[要処理] または [処理中] の調査結果は [未解決の問題] として扱われます。コードの Polyspace 解析で既知の欠陥、許容可能な欠陥、またはコーディングルール違反が検出された場合、以降の解析でこの [未解決の問題] のリストからその欠陥や違反を削除するには、前述のいずれかの正当化ステータスを割り当てます。

コードのコメントまたは注釈

Polyspace の結果への応答として、コードエディターで特定のコードコメントや注釈を追加することもできます。コードコメントまたは注釈を特定の構文で入力した場合、ソフトウェアでは次回のコード解析時にそれを読み取って、結果の詳細の [重大度]、[ステータス]、および [コメント] フィールドに入力します。

注釈構文については、コードへの注釈付けと既知の結果または許容可能な結果の非表示 (Polyspace Bug Finder)を参照してください。

注釈にステータスを明示的に指定しない場合、Polyspace では [アクションの予定なし] のステータスが設定されたと想定します。

[ソースコード] ペインでのナビゲーションと Polyspace アクションの保存

Polyspace の [ナビゲーション履歴] ペインには、特定のレビューワークフローアクションが表示されます。

[ナビゲーション履歴] ペインでアクションをクリックすると、[結果の詳細] ペインにそのアクションに関連する結果が表示されます。次に [ソースコード] ペイン内で、そのアクションに関連付けられているコードの場所に移動します。結果のレビュープロセスを進める際、[ナビゲーション履歴] ペインを使用して以前の結果を再び参照し、[ソースコード] ペインで関連するコードを見つけます。

Polyspace が記録するアクションには以下が含まれます。

[結果のリスト] ペインでの結果の選択
[ソースコード] ペインの右クリックメニューからの [ナビゲーション履歴で位置を保持] の選択
[エラー呼び出しグラフ] や [変数アクセスグラフ] などのグラフ内でのノードの選択
[コード検索]、[呼び出し階層]、[グローバル変数の使用]、または [グローバル変数アクセス] ペインでの行の選択

[ナビゲーション履歴] ペインで重要なアクションにフラグを設定するには、そのアクションの行番号をクリックします。

Clear all actions アイコンをクリックすると、[ナビゲーション履歴] ペインからすべてのアクションが削除されます。

Navigation History pane

参考

トピック

コードへの注釈付けと既知の結果または許容可能な結果の非表示 (Polyspace Bug Finder)