SuperAPI AI 工具集

java-code-comments

编程与开发

查看项目

更新于 10-16 05:47

技能介绍

用途:当用户需要给 Java 代码添加注释、生成 JavaDoc、为类/方法/字段补充文档说明时使用。触发语包括“给这段代码添加注释”“生成 JavaDoc”“添加类注释”“添加方法注释”“添加属性注释”等。

主要能力:覆盖 Controller、Service、ServiceImpl、Application Service、Domain Service、Feign 接口、Mapper、Model、Entity、BO、DTO、VO、DAO、Repository、Configuration、Component、Utility、Exception 等组件类型;支持类注释、方法注释、属性注释三种层级;提供标准 JavaDoc 与严格《JAVA 编程规范》两套格式,后者要求描述用 <p> 标签包裹、@param 声明参数类型、@return 声明返回类型、@exception 使用完整包名。

使用方式:按四步工作流执行。第一步扫描并理解代码库,读取所有 .java 文件及相关 README、API、架构文档,识别项目结构、架构模式与命名约定;第二步让用户确认需要注释的组件类型与注释类型;第三步生成含类名、方法名、字段名的待办清单;第四步按“类注释→方法注释→属性注释”顺序逐类执行,每完成一个类更新待办清单并展示进度。技能内提供 templates/ 目录下的各类组件注释模板,以及 reference/javadoc-standards.md 与 reference/java-coding-standards.md 参考文档。

适用场景:为存量 Java 项目补充文档注释、统一团队注释风格、按 DDD 分层生成规范注释。

限制:只添加注释,不修改代码逻辑;需先扫描代码库并等待用户确认组件类型后才能继续;严格格式仅在项目明确遵循《JAVA 编程规范》时使用。资料未提供具体安装命令、收费方式与平台支持信息。