Visual Studio Code 向け Perforce Static Analysis 拡張機能をお使いになる前に

Klocwork メニュー (アクティビティバーの「kw」アイコン) で [アクション] ビューを選択し、解析の実行、プロジェクトの同期、またはKlocwork サーバーに対するプロジェクトの認証を行うことができます。

解析の実行

[解析の実行] を選択することで、現在のワークスペースに対して解析を手動で実行し、コード内で検出された問題を見つけることができます。Klocwork がファイル内の問題を検出すると、[問題] タブに指摘のリストが表示されるだけでなく、エディターの右の余白に指摘マーカーが表示されます。

同期

[同期] を選択することで、ローカルプロジェクトで見つかった指摘を、Klocwork サーバーで見つかった指摘と手動で同期させることができます。同期は、接続したプロジェクトで解析を実行している間に、自動的に実行されることに注意してください。拡張機能を長期間使用している場合、サーバーから欠陥を引用している場合、または最近の引用活動をすぐにプルダウンしたい場合は、手動で実行することが望ましいでしょう。

認証

[認証] を選択することで、認証設定を検証できます。このオプションを選択すると、Klocwork サーバーに対してプロジェクトを認証するには、Klocwork サーバーの URL、ユーザー名、およびパスワードを入力するように求められます。これは、接続したプロジェクトで解析を実行し、欠陥を引用するために必要です。

continuous analysis (継続的デスクトップ解析) は、Visual Studio Code で作業中に自動指摘検出とエラーのハイライトを提供します。この機能は、[ファイル] > [プリファレンス] > [設定] > [拡張機能] > [Klocwork] の順に開き、[継続的解析を有効にする] を選択することによって有効にします。この設定を有効にすると、2 秒を超えてタイピングを中止するたびに Klocwork によってコードの解析が行われます。

'Klocwork 解析の実行' コマンドを実行すると、この拡張機能によってすべてのファイルが保存されます。解析が完了すると、結果が [問題] タブに表示されます。このタブの詳細については、フィルターオプションを参照してください。

欠陥履歴により、選択した指摘に対して行われた以前のコメントや引用の変更を確認できます。それには、次のようにアクセスできます。

1. Klocwork 解析中に見つかった指摘は、[問題] タブにあります。このタブを表示するには、[ビュー] > [表示] > [パネルを表示] の順に選択します。リストで指摘をダブルクリックして、ソースコード内でそれを表示します。
2. 指摘に関するクイックアクションメニュー (電球アイコン) にアクセスすると、次のことができます。
   • (これまでの指摘履歴が存在する場合に) 指摘の履歴を確認するには、[Klocwork 欠陥履歴の表示] を使用します。
   • 指摘に関するチェッカーヘルプにアクセスする
   • 指摘ステータスを設定する

   同じ範囲内に複数の欠陥が存在する場合、検出された指摘ごとに個別のヘルプリンクが表示されます。

Klocwork extension for Visual Studio Code により、[問題] タブ内で指摘を表示する方法をカスタマイズできます。

• 指定したステータスの指摘を表示するフィルター（「解析」と「修正」がデフォルトで選択されています）
• ローカルの指摘やシステムの指摘を表示するフィルター
• 分類基準を表示するフィルター
• 重大度を表示するフィルター

変更を適用するには、フィルターを調整した後に、[フィルターオプション] ビューで [フィルターの適用] を選択します。

Visual Studio Code 内で、Klocwork メニューにある [Klocwork プロジェクト設定] を開くことで、Klocwork 拡張機能に関する設定を行うことができます。以下を行うことができます。

• [接続設定] で、次を定義できます。
  • Klocwork サーバーの場所 (ホスト、ポート、安全な接続)
  • ライセンスホストとポート (Klocwork サーバーの構成済みライセンス設定と異なる場合)
  • 接続する Klocwork プロジェクトの名前
  このダイアログを初めて開いたときに、[Klocwork プロジェクト設定の初期化] を選択して、ワークスペース用の Klocwork 解析フォルダーを自動的に作成する必要がありす。
• [ビルドスペック設定] で、次を行うことができます。
  • [ビルドスペックの自動更新] を設定して、Klocwork 拡張機能にビルドスペックを生成させるようにします。これを設定しなければ、拡張機能の外部で生成する必要があります。
  • ビルドスペック生成コマンド (たとえば、kwinject msbuild /t:rebuild cs.sln -p:UseSharedCompilation=false -p:ProduceReferenceAssembly=false) を追加します。
  • ビルドスペックの場所を手動で設定します (デフォルトでは、現在のワークスペースのルートディレクトリになります)。

このコマンドを手動で作成するために、task.json ファイルをガイドとして使用できます。build specification (ビルドスペック) の作成を参照してください。

        {
            "label": "compile",
            "type": "shell",
            "command": "mvn",      <-- (1) maven project
            "args": [
                "compile"          <-- (2) compilation arguments
            ],
            "group": "build"
        }

Klocwork extension for Visual Studio Code に使用されるカスタムコマンドには、キーバインドでアクセスできます。拡張機能は、デフォルトでそうしたキーバインドに寄与することはありませんが、ワークフローをカスタマイズするために追加できるいくつかの例をここに示します。

    {
        "key": "ctrl+k ctrl+a",
        "command": "kwvscodeextension.runAnalysis"
    }

    {
        "key": "alt+shift+k",
        "command": "workbench.view.extension.klocwork-options"
    }

Configuration Editor でチェッカーの有効と無効を切り替えます。チェッカーの詳細については、C および C++ チェッカーリファレンス、Java チェッカーリファレンス、または C# チェッカーリファレンスを参照してください。[検索] フィールドを使用して、チェッカーのコード、タイトル、リファレンス、カテゴリ、または分類基準別に検索します。変更内容が反映されるのは、次回解析を開始するときです。

Visual Studio Code に関する注意: 接続されたプロジェクトの場合、VS Code 拡張機能は、サーバーのプロジェクトチェッカー構成を使用して、それらを自動的に同期します。ローカルプロジェクト用にチェッカーを有効または無効にする場合は、スタンドアロン Configuration Editor の使用を参照してください。