如何在 VSCode 中利用 CodeGeeX 自动生成详细的代码注释

夜丽小哥_3697

夜丽小哥_3697

2026-06-18

1008人浏览

原创

codegeex支持三种高效注释生成方式:右键一键添加、/comment指令精准控制、引导性注释定制输出,并可设置中英文偏好与自定义模板。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如何在 vscode 中利用 codegeex 自动生成详细的代码注释

当你在 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”。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

用引导性注释驱动定制化输出

当项目强制要求特定注释规范(如 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 */

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode codegeex

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
CodeGeeX下载安装教程合集
CodeGeeX下载安装教程合集

提供CodeGeeX最新版下载地址、历史版本下载、VS Code安装教程、JetBrains安装教程及常见安装问题解决方案。

2026.06.16

516

15

CodeGeeX代码生成教程合集
CodeGeeX代码生成教程合集

汇总CodeGeeX代码生成技巧、代码补全教程、单元测试生成、代码优化及实际开发案例。

2026.06.16

517

31

CodeGeeX大模型教程合集
CodeGeeX大模型教程合集

详细介绍CodeGeeX底层模型能力、多语言代码生成效果、模型架构及应用场景

2026.06.16

136

10

CodeGeeX VSCode插件教程大全
CodeGeeX VSCode插件教程大全

专注CodeGeeX VS Code插件的安装配置、功能使用、快捷键及开发实践。

2026.06.16

590

15

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

20

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

0

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

0

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

20

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

20

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程