このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

Visual Studio Code での Polyspace as You Code 用チェッカーの構成

Visual Studio Code で Polyspace® as You Code を使用して、欠陥とコーディング ルール違反をチェックできます。既定の解析では、既定の Polyspace Bug Finder™ の欠陥がチェックされます。その他の欠陥とコーディング ルール違反をチェックするには、Polyspace as You Code 拡張機能を構成します。

チェッカーを構成するときには、既存のチェッカー ファイルを再利用できます。あるいは、IDE からチェッカー ファイルを直接作成できます。Polyspace デスクトップおよびサーバーでの同等のワークフローについては、Polyspace Bug Finder 解析用のチェッカー構成の準備 (Polyspace Bug Finder)を参照してください。

利用できるリソースまたはアーティファクトに応じて、次のいずれかの方法を使用して IDE 拡張機能でチェッカーを構成します。

既存のチェッカー アクティベーション ファイルの使用

チェッカー アクティベーション ファイル (XML) またはユーザー定義のコーディング規約 (.pschk) を使用してチェッカーを構成できます。チェッカー アクティベーション ファイルにより、一連の Bug Finder の欠陥と外部コーディング ルールが有効になります。ユーザー定義のコーディング規約では、既存のコーディング規約がニーズに厳密に対応していない場合に、特にプロジェクトに関係するコーディング ルールを 1 つの規約にまとめることができます。これらのアーティファクトのいずれかがある場合は、[設定] ペインでそのアーティファクトのパスを指定します。

  1. [構成] ペインの Settings をクリックします。

  2. [Polyspace] 、 [Analysis Options:Checkers file] 設定に、チェッカー アクティベーション ファイルまたはカスタム コーディング規約の絶対パスを入力します。

必要に応じてチェッカーの選択を変更できます。[構成] ペインで [チェッカーの構成] アイコン configure checkers icon をクリックして [チェッカーの選択] ウィンドウを開きます。チェッカーの選択を変更して、変更内容を保存します。[終了] をクリックしてウィンドウを閉じます。

プロジェクトからのチェッカー構成のインポート

Polyspace デスクトップ プロジェクト ファイル (.psprj) がある場合は、このファイルからチェッカー構成をインポートできます。コマンド ラインで、以下を入力します。

ps-migrate-checkers-selection -import-options-from-psprj PathToProject

  • コマンド ps-migrate-checkers-selection はフォルダー polyspaceroot\polyspace\bin\arch にあります。polyspaceroot は、使用している開発環境の Polyspace インストール フォルダーの場所であり、arch は win64、glnxa64、maci64 のいずれかです。

  • PathToProject は Polyspace デスクトップ プロジェクトの絶対パスです。

コマンドの実行後に、Polyspace により、インポートされたチェッカー構成を使用してチェッカー アクティベーション ファイルが作成されます。このチェッカー アクティベーション ファイルは、.psprj ファイルと同じ場所の import という名前のサブフォルダーに格納されます。Visual Studio Code の [チェッカー ファイル] 設定に、チェッカー アクティベーション ファイルのパスを指定します。

あるいは、Polyspace Platform ユーザー インターフェイスで .psprj ファイルを開いて、この .psprj プロジェクト ファイルを .psprjx プロジェクト ファイルとしてインポートできます。Polyspace は .psprj ファイルのチェッカー構成を使用してチェッカー アクティベーション ファイルを作成します。チェッカー アクティベーション ファイルのパスを取得するには、[構成] に移動して [静的解析] タブを選択します。[欠陥とコーディング規約] 、 [チェッカー アクティベーション ファイル] にこのパスがあります。Visual Studio Code の [チェッカー ファイル] 設定に、チェッカー アクティベーション ファイルのパスを指定します。

詳細は、Generate Build Options for Polyspace as You Code Analysis in Visual Studioを参照してください。

チェッカー構成の作成

チェッカー アクティベーション ファイル (XML) がない場合は、[チェッカーの選択] ウィンドウを使用してこのファイルを作成できます。[チェッカーの選択] ウィンドウからユーザー定義のコーディング規約 (.pschk) を作成する操作はサポートされていません。独自のユーザー定義のコーディング規約を作成する方法の詳細については、Create User-Defined Coding Standard by Using Polyspace Bug Finder Checkers (Polyspace Bug Finder)を参照してください。

  1. [チェッカーの選択] ウィンドウを開くには、[構成] ペインで [チェッカーの構成] アイコン configure checkers icon を選択します。

    Polyspace Checkers selection interface

  2. [チェッカーの選択] ウィンドウで、有効にするチェッカーを選択します。また、事前定義された欠陥チェッカー カテゴリを有効にすることもできます ([すべて]、[既定]、[高]、[中]、[低] など)。影響度による欠陥の分類 (Polyspace Bug Finder)を参照してください。同様に、対応する規約によって定義されているコーディング ルールの事前定義済みセットを有効にすることができます。

    • [Guidelines] 、 [Software Complexity] チェッカーを選択する場合、それぞれのしきい値をレビューします。既定のしきい値が許容できない場合、[しきい値] 列で適切なしきい値を指定します。ガイドラインをチェック (-guidelines) (Polyspace Bug Finder) を参照してください。

    • [カスタム] ルールを選択した場合、ルールの [パターン] および [規則] をレビューします。カスタム ルールのチェック (-custom-rules) (Polyspace Bug Finder) を参照してください。

    • 独自の分類タグを使用して Bug Finder の欠陥またはコーディング ルール チェッカーを分類する場合は、[チェッカーの選択] ウィンドウの [コメント] 列にテキストを入力します。Polyspace では、デスクトップ インターフェイス、Polyspace Access™、または Polyspace as You Code プラグインで結果を確認するときに、入力したそのテキストが [結果の詳細] ペインおよび (使用できる場合は) [結果のリスト] の [詳細] 列に表示されます。

      メモ

      [チェッカーの選択] ウィンドウで入力するカスタム テキストは、以下では省略されます。

      • 生成されるレポート。

      • Polyspace デスクトップ インターフェイス (Polyspace Access から結果を開く場合)。この制限は Bug Finder チェッカーにのみ適用されます。

  3. [変更の保存] をクリックして、再利用可能なチェッカー XML ファイルとして選択を保存します。[終了] をクリックしてウィンドウを閉じます。

後でこのチェッカー XML ファイルを [チェッカー ファイル] フィールドの入力として再利用できます。

チェック動作の変更

Bug Finder 欠陥チェッカーとコーディング ルールの既定の動作を変更するには、解析オプションを使用します。チェッカーの既定の動作を変更する解析オプションのリストについては、Bug Finder チェッカーの既定の動作の変更 (Polyspace Bug Finder)を参照してください。

Polyspace as You Code で解析オプションを指定するには、次のようにします。

  • [Polyspace] 、 [Analysis Options:Other Analysis Options File] フィールドで指定されたオプション ファイルで解析オプションを追加します。この設定は [オプション] ウィンドウの [解析設定] セクションにあります。各行に 1 つの解析オプションがあるテキスト ファイルのパスを指定します。たとえば、解析オプション -code-behavior-specifications (Polyspace Bug Finder) および[有効な boolean 型] (-boolean-types) (Polyspace Bug Finder) を追加するには、オプション ファイルで次の行を追加します。

    -code-behavior-specifications file1
-boolean-types boolean1_t,boolean2_t
    ここで、file1 はコード動作仕様ファイル (XML) であり、boolean1_t,boolean2_t は boolean 型です。

  • オプション ファイルがない場合は、必要なオプションが入ったオプション ファイルを作成してください。新しいオプション ファイルのパスを [Polyspace] 、 [Analysis Options:Other Analysis Options File] フィールドで指定されたオプション ファイルで解析オプションを追加します。Polyspace 解析のオプション ファイル (Polyspace Bug Finder)を参照してください。

参考

トピック