Main Content

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

Visual Studio Code で Polyspace® as You Code を使用して、さまざまなタイプの欠陥とコーディング ルール違反をチェックできます。欠陥 (Polyspace Bug Finder)コーディング規約 (Polyspace Bug Finder)を参照してください。既定の解析では、欠陥のサブセットがチェックされます。既定で有効な Polyspace Bug Finder 欠陥チェッカー (Polyspace Bug Finder)を参照してください。既定以外の欠陥とコーディング ルール違反をチェックするには、IDE で Polyspace as You Code 拡張機能を構成します。

チェッカーを構成するには、チェッカー ファイルを作成した後、拡張機能設定でそのチェッカー ファイルを指定します。Polyspace デスクトップおよびサーバーでの同等のワークフローについては、Polyspace Bug Finder 解析用のチェッカー構成の準備 (Polyspace Bug Finder)を参照してください。

チェッカー ファイルでのチェッカーの構成

チェッカーを構成するには、最初にチェッカー ファイルでチェッカーを選択します。次に [設定] ペインでそのチェッカー ファイルを指定します。

手順 1: チェッカーとコーディング ルールの選択

既定以外の欠陥およびコーディング ルールを有効にするには、次のいずれかを行います。

  • チェッカー ファイルを作成または変更する。

  • Polyspace デスクトップ プロジェクトからチェッカーの選択をインポートする。

チェッカー ファイルの作成または変更.  [チェッカーの選択] ウィンドウで、チェッカーとコーディング ルールの選択を新しく作成するか、既存の選択を変更します。再利用可能なチェッカー ファイルに新しい構成を保存します。チェッカーの選択を変更せずに既存のチェッカー ファイルを使用するには、[設定] ペインでそのファイルのパスを指定します。手順 2: 拡張機能設定でのチェッカー ファイルの指定を参照してください。

  1. [チェッカーの選択] ユーザー インターフェイスを開くには、コマンド パレットから Polyspace: Configure Checkers を実行します。

    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 ファイルを [チェッカー ファイル] フィールドの入力として再利用できます。[終了] をクリックします。

デスクトップ プロジェクトからチェッカー構成をインポートする.  Polyspace デスクトップ プロジェクト ファイル (*.psprj) がある場合は、このファイルからチェッカー構成をインポートできます。Visual Studio Code ターミナルで以下を実行します。

#Linux command
polyspace-checkers-selection -checkers-selection-output-file PathToOutputFile.json \
-import-options-from-psprj PathToProject.psprj

#DOS command

polyspace-checkers-selection.exe -checkers-selection-output-file PathToOutputFile.json ^
-import-options-from-psprj PathToProject.psprj
ここで、PathToProject.psprj は Polyspace デスクトップ プロジェクト ファイルの絶対パスであり、PathToOutputFile.json は JSON ファイルの絶対パスです。JSON ファイルは書き込み可能なフォルダーに含まれていなければなりません。JSON ファイルには、作成されたチェッカー ファイルの場所が次の形式で記述されています。
    {
        "checkers-activation-file": "GeneratedCheckersActivationFile",
        "analysis-options-file": "GeneratedAnalysisOptionFile"
    }
GeneratedCheckersActivationFile のチェッカー ファイルには、Polyspace デスクトップ プロジェクト ファイルからインポートしたチェッカー構成が含まれています。

手順 2: 拡張機能設定でのチェッカー ファイルの指定

チェッカー ファイルの作成後に、[Settings] ペインにファイルのパスを指定します。

  • サイドバーで [Extensions] ボタンをクリックします。[Extensions] ペインが開き、インストールされている拡張機能のリストが表示されます。

  • [Extensions] ペインで Polyspace as You Code を見つけます。Settings をクリックして [Extension Settings] を選択します。

  • [Settings] ペインの [チェッカー ファイル] フィールドに、チェッカー ファイルのパスを指定します。

チェック動作の変更

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

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

  • [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

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

関連するトピック