解释代码

watsonx Code Assistant

使用生成式人工智能分析和总结代码，了解代码的作用。

下表列出了每个计划的解释类型。

解释类型
套餐 说明 描述
试用计划 基本计划 基本 使用生成式人工智能提供基本解释。 无需进行额外的代码分析。
标准套餐 增强 需要构建应用程序，并使用代码分析和生成式人工智能为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解释代码

在集成开发环境编辑器中，CodeLens会在代码块和代码段之前显示一行生成式人工智能选项。

已知问题如果使用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 设置条目中，清除 Enable CodeLens 环境。

  3. 单击“应用”并关闭。

使用资源管理器解释代码

从资源管理器 ( Visual Studio Code ) 或项目资源管理器 ( Eclipse ) 生成说明：

  1. 将应用程序扩展到要生成解释的代码。

  2. 右键单击代码，单击 watsonx Code Assistant，然后单击解释。

  3. watsonx Code Assistant聊天会显示您所选代码的 "/explain 命令。 该命令使用以下语法：

    /explain <code syntax>

  4. Watsonx Code Assistant会处理请求，并在聊天中显示您所选代码的解释。

解释Java应用程序

[标准计划]“{: tag-purple}只有”watsonx Code Assistant for Enterprise Java Applications扩展名才有应用解释。

应用程序解释仅支持包含一个或多个扩展 "javax.servlet.http.HttpServlet 的类的Java应用程序。 这些类需要实现以下任意一种方法："doGet、"doPost 或 "doPut。

对于大型应用，解释会考虑 循环复杂度最高的 40 个入口点。 如果申请超过 40 个入境点，解释中的 The following methods were not considered: 部分将详细说明哪些入境点未予考虑。

申请并查看申请解释：

  1. 在集成开发环境中，右键单击要解释的应用程序目录下层次结构中的任意项目，然后单击“解释应用程序”。

    在 Eclipse IDE 中，如果多模块应用程序具有对等多模块根，则应用程序解释仅适用于所选模块。

  2. Watsonx Code Assistant扫描应用程序，生成概述和主要服务列表，并说明每种方法的功能。

  3. 单击“保存” 保留副本，否则解释将被丢弃。

  4. 单击“打开说明并查看”，然后单击“保存应用程序说明”将其存储到本地文件中。