CodeGeeX注释生成方法

写代码时，最头疼的环节之一，就是写完一段逻辑后还要回头补注释——格式对不对、字段全不全、要不要加异常说明……反复折腾。CodeGeeX 在这件事上提供了四种不同的生成路径，覆盖了从“写完就想贴上去”到“项目有严格规范你得听我的”各种场景。下面把这四种方式拆开讲清楚，看看哪种更适合你的日常操作。

说白了，你真正想要的是，在写完一段函数、类或接口之后，能立刻配上规范、准确、符合项目风格的注释，而不是反复删改、查文档、纠结标点格式。CodeGeeX 的四种方式，正是为这个目标而设计的。

右键菜单一键加注释

这是最省心的方式，适合已经写完代码、想快速补全说明的场景。操作很简单：鼠标拖选目标代码块（可以是单行、一个方法、整个 class 声明），右键，在弹出菜单里找到「CodeGeeX Tool」，点击「Add Comment」。等待右下角 CodeGeeX 图标停止旋转，注释就会以灰色预览形式自动插入到代码上方或内部对应位置。最后一步不能忘：按 Tab 键确认插入，或者按 Esc 键取消。否则注释不会真正落地。

用 /** 回车触发 OpenAPI 注释

这一招专门为 Spring Boot Controller 设计，能生成带 @Operation、@Parameter、@ApiResponse 的标准 Ja vaDoc。操作要点：把光标放在目标 REST 方法（比如 @GetMapping）正上方的空行，输入 /** 后立刻按 Enter（回车），不要多打空格或换行。CodeGeeX 会自动补全完整 Ja vaDoc 块，而且还带着业务语义填充的中文 summary 和 description。如果方法参数是已编译的 DTO，字段级描述也会展开——不过要注意，DTO 必须已经在当前 module classpath 中成功编译，否则一律标记为 object。

用自然语言注释引导定制输出

当项目有强约束规范时——比如 Swagger 注解、Google Python docstring、JSDoc 特定标签——纯模型推断容易漏字段，这时候你得“告诉它怎么写”。具体做法有两种：一种是在函数上方空行手写指令，比如“// 生成 Swagger 兼容注释：描述为‘根据ID查询用户’，参数 id 为路径变量，返回 User 对象，404 时抛出 ResourceNotFoundException”。把光标停在这行末尾，按 Ctrl+Enter（Windows/Linux）或 Cmd+Enter（macOS）激活交互模式。CodeGeeX 会解析其中的结构化指令，生成含 @ApiParam、@ApiResponse 等完整注解块。从候选结果中点击“Use Code”插入——注意，这步不会覆盖已有合法注释，但会替换非法开头（比如 // 而不是 /**）的整块内容。

命令面板调用智能问答模式

这个模式适合调试中途临时补注，或者对某段逻辑不确定该强调什么的时候用。先确保 CodeGeeX 侧边栏已经打开（视图 → 插件扩展视图 → CodeGeeX），然后在 Ask CodeGeeX 输入框中输入 /comment 并回车。如果光标在函数内部，系统会默认生成参数说明、返回值描述及异常标注；如果光标在空行，就需要手动补充上下文，比如“为下方 Ja va 方法添加 Ja vadoc 格式注释，强调线程安全性”。从右侧候选列表中点击“Use Code”按钮完成插入。