语言支持和标准

下表列出了代码语言以及每种代码语言对应的文档标准。

当您引用方法或在方法上使用 CodeLens 时，watsonx Code Assistant 支持某些代码语言。 引用完整文件适用于所有语言。 更多信息，请参阅 使用方法时的语言支持。

使用聊天命令生成文档

您可以在聊天中使用 "/document 命令为活动工作区中的引用文件、方法或类生成文档。

使用以下语法：

/document <code reference> [additional instructions]

• 确保以 /document 开头，然后是其余语法。

• 对于“<code reference>，输入”@ 符号可查看工作区中的文件、类和方法列表。 一次只使用一个文件、方法或类引用。

• [additional instructions] 为可选项。 如果需要具体细节，请添加说明。

引用文件时，大小限制为 50 KB。 如果达到此限制，请将文件分割成单个函数，并引用每个函数。 或者，将文件分割为 49 KB，注意函数边界，并在每次分割时引用文件。 无论采用哪种方法，都需要合并结果。

在编辑器中使用CodeLens生成文档

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

1. 点击代码块或代码段前面的文档选项，生成其文档。

   在下面的代码示例中，“Explain | Document | Unit Test 选项紧接着”protected void 关键字。

   

2. watsonx Code Assistant聊天窗口打开，显示 "/document @<*item name*> 命令，运行该命令，并显示代码和作为注释添加的文档。