SuperAPI AI 工具集

java-code-comments

编程与开发

查看项目

更新于 10-16 03:15

技能介绍

用途:当需要为 Java 代码添加注释、生成 JavaDoc 文档注释、改进代码文档时使用。触发场景包括给代码添加注释、生成类/方法/属性注释、代码注解等。

主要能力:处理多种组件类型,包括 Controller、Service、ServiceImpl、Application Service、Domain Service、Feign 服务接口、Mapper、Model、Entity、BO、DTO、VO、DAO、Repository、Configuration、Component、Utility、Exception 等。支持标准 JavaDoc 与严格 Java 编程规范两种注释格式,后者要求描述用 <p> 标签包裹、参数与返回值需声明类型、异常需带完整包名。

使用方式:遵循四步工作流。第一步扫描并理解代码库,读取所有 .java 文件及相关文档,识别项目结构与架构模式。第二步让用户确认需要注释的组件类型和注释类型。第三步生成带类名和方法名的待办清单。第四步按类注释、方法注释、属性注释的顺序执行,每完成一个类更新待办清单。提供 templates/ 下的组件注释模板以及 reference/ 下的 JavaDoc 与编程规范参考。

限制:仅依据资料,未提供收费、价格、平台或效果等信息;不修改代码逻辑,仅添加注释。具体安装命令暂未提供。