CodeGeeX生成注释方法

酷芳酱_6945

酷芳酱_6945

2026-07-19

106人浏览

原创

codegeex提供四种注释生成方式:右键菜单一键添加、/**回车触发openapi注释、自然语言指令定制、命令面板智能问答,覆盖不同场景与精度需求。

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

codegeex生成注释方法

你想在写完一段函数、类或接口后,立刻配上规范、准确、符合项目风格的注释,而不是反复删改、查文档、纠结标点格式——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
CodeGeex 2.21.0

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 按钮完成插入。

相关文章

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

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

下载

相关标签:

codegeex

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

相关专题

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

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

2026.06.16

596

15

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

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

2026.06.16

577

31

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

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

2026.06.16

136

10

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

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

2026.06.16

650

15

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

2026.10.10

80

15

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

2026.10.10

40

15

Kratos框架Protobuf接口定义与代码生成合集
Kratos框架Protobuf接口定义与代码生成合集

本专题讲解Kratos框架接口定义体系,涵盖proto编写规范、proto add/client/server生成命令、http注解路由、validate校验、OpenAPI文档生成、跨服务proto复用与兼容性设计。

2026.10.10

20

15

C++虚函数怎么定义和调用
C++虚函数怎么定义和调用

C++虚函数是实现运行时多态的重要机制。本专题从virtual关键字的基本用法入手,介绍基类与派生类之间的函数重写、基类指针调用派生类方法,以及动态绑定的执行过程,帮助初学者掌握虚函数的核心语法。

2026.10.10

20

26

C++类与对象的封装方法教程
C++类与对象的封装方法教程

C++封装是面向对象编程的核心特性之一,通过类将数据与操作数据的函数组织在一起,并利用访问权限控制外部访问。本专题介绍类的定义、成员变量、成员函数以及public、private和protected的使用方法,帮助初学者掌握封装的基本原理。

2026.10.10

20

32

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CodeGeex使用手册
CodeGeex使用手册

共0课时 | 0人学习