言語サポートと規格

次の表は、コード言語と、各コード言語に対応する文書規格の一覧です。

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

チャットコマンドを使ってドキュメントを作成する

チャットで'/document コマンドを使用すると、参照されているファイル、アクティブなワークスペース内のメソッドやクラスのドキュメントを生成することができます。

次の構文を使用します。

/document <code reference> [additional instructions]

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

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

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

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

エディターでCodeLensを使用してドキュメントを生成する

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

1. コードブロックやスニペットの直前にある 「ドキュメント」 オプションをクリックすると、そのドキュメントが生成されます。

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

   

2. watsonx Code Assistantチャット・ウィンドウが開き、'/document @<*item name*> コマンドが表示され、コマンドが実行され、ドキュメントがコメントとして追加されたコードが表示される。