コードの説明

watsonx Code Assistant

生成AIを使ってコードを分析し、要約することで、コードが何をしているのかを理解する。

以下の表は、各プランの説明の種類を示している。

説明の種類
プラン 説明 説明
トライアルプラン エッセンシャルプラン 基本 生成AIを使って基本的な説明を行う。 余計なコード解析は必要ない。
標準プラン 拡張 ビルドされたアプリケーションが必要で、コード解析と生成AIを使用して、Javaメソッド/クラスとエンタープライズJavaアプリケーションのコード説明を強化します。

**Eclipse IDE ** のみ ：マルチモジュール Javaで最良の結果を得るには、アグリゲーター・モジュールと各サブモジュールを Eclipse内の個別のプロジェクトとしてインポートしてください。最上位ディレクトリを単一プロジェクトとしてインポートすると Watsonx Code Assistantプロジェクトを正しく内省できない可能性があります。

言語サポート

コードに関する製造業者、販売業者、サービス提供業者は次の言語でも提供されます：

  • C
  • C++
  • Go
  • Java
  • JavaScript
  • Python
  • TypeScript

メソッドを参照するとき、またはメソッドで CodeLens を使用するとき、 watsonx Code Assistant は特定のコード言語をサポートします。 完全なファイルを参照することは、すべての言語で機能します。 詳細については、 メソッドを使用する際の言語 サポートを参照してください。

チャットコマンドを使ってコードを説明する

チャットで「/explain コマンドを使用すると、アクティブなワークスペースで参照されているクラス、ファイル、関数、メソッドのコードを説明することができます。

次の構文を使用します。

/explain <code reference> [additional instructions]

  • プロンプトの先頭に /explain をつけ、その後に残りの構文を続けてください。

  • <code reference> に対して、'@ シンボルを入力すると、ワークスペースのクラス、ファイル、関数、メソッドのリストが表示される。 一度に1つのクラス、ファイル、関数、メソッド参照を使用する。

  • [additional instructions] は任意である。 特定の詳細が必要な場合は、指示を追加してください。

ファイルを参照する際のサイズ制限は50KBです。 この制限に達した場合は、ファイルを個々の関数に分割し、各関数を参照してください。 あるいは、関数の境界に注意して49KBでファイルを分割し、分割ごとにファイルを参照する。 どちらの方法でも、結果を統合する必要がある。

エディターのCodeLensてコードを説明する

IDEエディターでは、CodeLensはコードブロックやスニペットの前に生成AIオプションの行を表示する。

既知の問題 watsonx Code Assistant for Enterprise Java Applications拡張機能を使用している場合、起動時にCodeLensから拡張Java機能が利用できるようになるまで数秒かかることがあります。

  1. コードブロックの直前にある 「説明」 オプションをクリックすると、説明が表示されます。

    以下のコード例では、「Explain | Document | Unit Test オプションは「protected void キーワードの直前にある。

    CodeLensの例

    CodeLens の例
    CodeLens の例

  2. watsonx Code Assistantチャットウィンドウが開き、「/explain @<*item name*> コマンドを表示し、コマンドを実行し、説明を表示する。

無効化 CodeLens

CodeLens オプションを無効にしたい場合は、拡張機能またはプラグインの設定を変更してください。

Visual Studio Code ：

  1. 拡張機能の設定を開きます。

  2. Enable CodeLens の設定をクリアする。

Eclipse ：

  1. Eclipse IDE の設定を開く。

  2. watsonx Code Assistant Settingsの項目で、 Enable CodeLens の設定をクリアする。

  3. Apply をクリックして閉じる。

エクスプローラを使ってコードを説明する

エクスプローラー（ Visual Studio Code ）またはプロジェクトエクスプローラー（ Eclipse ）から説明を作成する：

  1. 説明を生成したいコードまでアプリケーションを広げてください。

  2. コードを右クリックし、watsonx Code Assistant をクリックし、次に Explain をクリックします。

  3. watsonx Code Assistantチャットは、選択したコードの'/explain コマンドを表示する。 コマンドには以下の構文が使われる：

    /explain <code syntax>

  4. Watsonx Code Assistantはリクエストを処理し、選択したコードの説明をチャットに表示します。

Javaアプリケーションの説明

標準プランアプリケーションの説明は、watsonx Code Assistant for Enterprise Java Applications拡張子でのみ利用可能です。

アプリケーションの説明は、'javax.servlet.http.HttpServlet 継承するクラスを1つ以上含むJavaアプリケーションでのみサポートされます。 これらのクラスは、'doGet、'doPost、'doPut のいずれかのメソッドを実装する必要がある。

大規模なアプリケーションでは、 サイクロマティック複雑度が最も高い40のエントリーポイントを考慮する。 エントリーポイントが40点を超えた場合、説明には、どのエントリーポイントが考慮されなかったかについての詳細が記載されたセクション（ The following methods were not considered: ）が含まれます。

申請に関する説明を求め、閲覧すること：

  1. IDEで、説明したいアプリケーションのディレクトリ内の階層にある項目を右クリックし、 [Explain Application ]をクリックします。

    Eclipse IDEでは、マルチモジュール・アプリケーションでピア・マルチモジュール・ルートがある場合、アプリケーションの説明は選択したモジュールにのみ適用されます。

  2. Watsonx Code Assistantは、アプリケーションをスキャンして、各メソッドの機能の説明とともに、概要と主なサービスのリストを生成します。

  3. コピーを保持する場合は 「保存」をクリックし、そうでない場合は説明を破棄する。

  4. 説明を開いて確認する」をクリックし、「アプリケーションの説明を保存する」をクリックしてローカルファイルに保存することができます。