語言支援和標準

下表列出了程式碼語言以及每種程式碼語言對應的文檔標準。

當您引用方法，或在方法上使用 CodeLens 時，watsonx Code Assistant 支援特定的程式碼語言。 引用完整檔案適用於所有語言。 如需詳細資訊，請參閱 使用方法時的語言支援。

使用聊天命令產生文檔

您可以在聊天中使用 /document 命令為活動工作區中引用的檔案或方法或類別產生文件。

使用這個語法：

/document <code reference> [additional instructions]

• 確保以 /document 開始提示，接著是其餘的語法。

• 對於 <code reference>，鍵入 @ 符號以查看工作區中的檔案、類別和方法的清單。 一次使用一個文件、方法、類別引用。

• [additional instructions] 是可選的。 如果您需要特定詳細信息，請添加說明。

當您引用檔案時，大小限制為 50 KB。 如果達到此限制，請將檔案分割為個別函式，並參照每個函式。 或者，將檔案分割為 49 KB，注意函數邊界，並在每次分割時引用檔案。 無論採用哪一種方法，您都需要合併結果。

使用編輯器中的CodeLens產生文檔

在 IDE 編輯器中，CodeLens在程式碼區塊和片段之前顯示一行生成式 AI 選項。

1. 按一下緊鄰程式碼區塊或程式碼片段之前的 “文檔” 選項以產生其文件。

   在下列程式碼範例中，Explain | Document | Unit Test 選項緊鄰 protected void 關鍵字之前。

   

2. watsonx Code Assistant聊天視窗打開，顯示 /document @<*item name*> 命令，執行該命令，並顯示程式碼以及作為註解新增的文件。