codegeex支持三种高效注释生成方式:右键一键添加、/comment指令精准控制、引导性注释定制输出,并可设置中英文偏好与自定义模板。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

当你在 VSCode 中写完一段逻辑复杂的函数却懒得逐行补全 Javadoc 或 docstring,又担心手动注释遗漏参数含义、异常路径或边界条件时,CodeGeeX 能直接基于语义生成结构清晰、语言贴切的注释块,且支持中英文自动切换和模板适配。
右键一键为选中代码添加注释
这是最直观、零记忆成本的方式,适合已写完待注释的函数、类或方法体。
1、用鼠标拖选目标代码段(可单行,也可跨多行选中整个 def 或 public void 方法)。
2、右键 → CodeGeeX Tool → Add Comment。
3、等待右下角 CodeGeeX 图标停止旋转,注释将以灰色预览形式插入代码上方——【若光标不在选区末尾,注释可能错位到文件顶部】。
4、按 Tab 键确认插入;按 Esc 可取消。
用 /comment 指令精准控制注释粒度
当你只想给当前光标所在函数加注释,或需要指定格式(如 Swagger 注解、Go 的 //go:generate 说明),这个方式更可控。
方法一:侧边栏触发
打开 CodeGeeX 侧边栏(视图 → 插件扩展视图 → CodeGeeX),在 Ask CodeGeeX 输入框中输入 /comment 并回车。
方法二:快捷指令触发
不打开侧边栏,直接在编辑器任意位置按下 Ctrl+Enter → 输入 /comment → 回车。
光标若落在函数定义行,CodeGeeX 默认识别该函数签名并生成含 @param、@return、@throws 的完整注释;若光标在空行,则需追加自然语言说明,例如:“为下方 Python 函数添加 Google 风格 docstring,强调输入必须为非空列表,空列表时抛出 ValueError”。
用引导性注释驱动定制化输出
当项目强制要求特定注释规范(如 Spring Boot 的 @ApiOperation + @ApiParam,或 Rust 的 /// 文档注释),纯模型推断容易漏字段。这时你得“教它怎么写”。
① 在目标函数上方空行,手写一行以 // 开头的中文指令,例如:// 生成 OpenAPI 3.0 兼容注释:描述为“批量创建订单”,请求体为 OrderBatchRequest,成功返回 201,失败返回 400 或 500
② 将光标置于该行末尾,按下 Ctrl+Enter。
③ CodeGeeX 解析后会生成带 @PostMapping、@RequestBody、@ApiResponse 等完整注解块的候选结果。
④ 点击右侧结果中的 Use Code 插入即可——这一步生成的注释几乎不用再手动删减字段。
设置默认语言与注释模板偏好
避免每次生成都输出英文注释,尤其当你主力开发中文项目时。
进入 VSCode 设置(Ctrl+,)→ 搜索 “CodeGeeX Explanation:Language Preference” → 下拉选择 “Chinese”。
该设置仅影响 /explain 和 /comment 输出的语言,不影响代码生成本身;【修改后无需重启,但已打开的侧边栏需关闭重开才能生效】。
若团队统一使用 JSDoc 模板,可在 CodeGeeX 设置中启用 “Custom Comment Template”,粘贴自定义模板字符串,例如:/**\n * ${description}\n * @param {${type}} ${name} - ${desc}\n * @returns {${returnType}}\n */











