解釋程式碼

watsonx Code Assistant

使用生成式 AI 來分析和總結您的程式碼，以了解程式碼的用途。

下表列出了每個計劃的說明類型。

解釋類型
方案 說明 說明
試用計劃 Essentials 計劃 基本 使用生成式人工智慧提供基本解釋。 不需要額外的程式碼分析。
標準計畫 加強 需要建立應用程序，並使用程式碼分析和生成式 AI 為Java方法/類別和企業Java應用程式提供增強的程式碼解釋。

僅限 Eclipse IDE：為了讓多模組 Java 應用程式達到最佳效果，請確保您在 Eclipse 工作區中將聚合器模組及各子模組匯入為單獨的專案。Watsonx Code Assistant 如果將頂層目錄作為單一專案匯入，就不太可能成功內省您的專案。

語言支援

程式碼解釋適用於以下語言：

  • C
  • C++
  • 進行
  • Java
  • JavaScript
  • Python
  • TypeScript

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

使用聊天命令解釋程式碼

您可以在聊天中使用 /explain 命令來解釋活動工作區中引用的類別、檔案、函數或方法的程式碼。

使用這個語法：

/explain <code reference> [additional instructions]

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

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

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

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

使用編輯器中的CodeLens解釋程式碼

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

已知問題如果您使用watsonx Code Assistant for Enterprise Java Applications擴展，啟動時可能需要幾秒鐘的時間才能從CodeLens中使用增強的Java功能。

  1. 點擊緊鄰程式碼區塊之前的 “解釋” 選項以產生解釋。

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

    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. 按一下套用並關閉。

使用探索器解釋程式碼

從 Explorer ( Visual Studio Code ) 或 Project Explorer ( Eclipse ) 產生說明：

  1. 將應用程式擴展至您想要產生說明的程式碼。

  2. 右鍵點選程式碼，按一下 watsonx Code Assistant，然後按一下說明。

  3. watsonx Code Assistant聊天顯示您選擇的程式碼的 /explain 指令。 該指令中使用以下語法：

    /explain <code syntax>

  4. Watsonx Code Assistant處理請求並在聊天中顯示您選擇的程式碼的說明。

解釋Java應用程式

標準計畫應用程式說明僅適用於watsonx Code Assistant for Enterprise Java Applications擴充。

僅包含一個或多個擴充 javax.servlet.http.HttpServlet 的類別的Java應用程式支援應用程式解釋。 這些類別需要實作以下任一方法：doGet、doPost 或 doPut。

對於大型應用程式，本解釋考慮了 40 個具有 最高 cyclomatic 複雜度的入口點。 如果申請超過 40 個入境點，說明包含 The following methods were not considered: 部分，提供哪些入境點未被考慮的詳細資訊。

要請求並查看應用程式的說明：

  1. 在 IDE 中，用滑鼠右鍵按一下要解釋的應用程式目錄中階層架構的任何項目，然後按一下「解釋應用程式」。

    在 Eclipse IDE 中，如果您有一個具有對等多模組根的多模組應用程序，則應用程式說明僅適用於所選模組。

  2. Watsonx Code Assistant掃描應用程式以產生概述和主要服務列表，以及每個方法的功能描述。

  3. 按一下 「儲存」 保留副本，否則說明將被丟棄。

  4. 按一下“開啟說明並檢視”，然後可以按一下 “儲存應用程式說明” 以儲存在本機檔案中。