CodeGeeX提供四种注释生成方式:右键菜单一键添加、/**回车触发OpenAPI注释、自然语言指令定制、命令面板智能问答,覆盖不同场景与精度需求。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你想在写完一段函数、类或接口后,立刻配上规范、准确、符合项目风格的注释,而不是反复删改、查文档、纠结标点格式——CodeGeeX 提供了四种即插即用的生成路径,适配不同场景和精度要求。
右键菜单一键加注释
这是最省心的方式,适合已写完代码、想快速补全说明的场景。
用鼠标拖选目标代码块(可以是单行语句、一个方法、整个 class 声明)→ 右键 → 在弹出菜单中找到「CodeGeeX Tool」→ 点击「Add Comment」。
等待右下角 CodeGeeX 图标停止旋转,注释会以灰色预览形式自动插入到代码上方或内部对应位置。
按 Tab 键确认插入,或按 Esc 键取消。这一步不能跳过,否则注释不会真正落地。
用 /** 回车触发 OpenAPI 注释
专为 Spring Boot Controller 设计,生成带 @Operation、@Parameter、@ApiResponse 的标准 JavaDoc。
将光标放在目标 REST 方法(如 @GetMapping)正上方的空行。
输入 /** 后立刻按 Enter(回车),不要多打空格或换行。
CodeGeeX 会自动补全完整 JavaDoc 块,含业务语义填充的中文 summary 和 description;若方法参数是已编译的 DTO,字段级描述也会展开——【DTO 必须已在当前 module classpath 中成功编译,否则一律标记为 object】。
用自然语言注释引导定制输出
当项目有强约束规范(比如 Swagger 注解、Google Python docstring、JSDoc 特定标签),纯模型推断容易漏字段,这时你得“告诉它怎么写”。
CodeGeeX 2.21.0是智谱AI推出的AI编程助手版本,对Inline Chat功能进行了重大优化,包括UI设计升级、支持流式输出以提升响应速度,并新增“查看思路”按钮以便理解代码原理。同时,该版本在编辑器中新增CodeLens控件,支持一键“解释”代码或“添加注释”。目前该工具对个人开发者免费开放。
方法一:在函数上方空行手写指令
// 生成 Swagger 兼容注释:描述为“根据ID查询用户”,参数 id 为路径变量,返回 User 对象,404 时抛出 ResourceNotFoundException
把光标停在这行末尾,按 Ctrl+Enter(Windows/Linux)或 Cmd+Enter(macOS)激活交互模式。
CodeGeeX 会解析其中的结构化指令,生成含 @ApiParam、@ApiResponse 等完整注解块。
从候选结果中点击 Use Code 插入——注意:这步不覆盖已有合法注释,但会替换非法开头(如 // 而非 /**)的整块内容。
命令面板调用智能问答模式
适合调试中途临时补注、或对某段逻辑不确定该强调什么时使用。
确保 CodeGeeX 侧边栏已打开(视图 → 插件扩展视图 → CodeGeeX)。
在 Ask CodeGeeX 输入框中输入 /comment 并回车。
若光标在函数内部,系统默认为该函数生成参数说明、返回值描述及异常标注;若光标在空行,则需手动补充上下文,例如:“为下方 Java 方法添加 Javadoc 格式注释,强调线程安全性”。
从右侧候选列表中点击 Use Code 按钮完成插入。

















