SuperAPI AI 工具集

170-java-documentation

编程与开发

查看项目

更新于 10-15 21:49

技能介绍

用途:为 Java 项目生成或改进文档,包括 README.md、package-info.java 和 Javadoc 增强,采用模块化、分步的交互式流程。

主要能力:README.md 生成,支持单模块与多模块 Maven 项目;package-info.java 创建,提供基础、详细、精简三种文档级别;Javadoc 增强,补充 @param、@return、@throws 标签;文件处理策略可选覆盖、追加、备份、跳过;最终通过 ./mvnw clean compile 和 ./mvnw javadoc:javadoc 做文档校验。

使用方式:先运行 ./mvnw validate 或 mvn validate 校验项目,失败则立即停止,待所有校验错误解决后再继续;随后阅读 references/170-java-documentation.md 并确定所需产出;按选定文件处理策略生成或更新文档;最后执行 ./mvnw clean compile 与 ./mvnw javadoc:javadoc 验证。

适用场景:为代码补充文档、应用文档、在重构中同步文档。

限制:应用任何文档生成前必须确保项目校验通过,校验失败须立即停止;应用前需阅读参考文件中的正反示例、约束与防护措施;若请求范围不明确,须先停止并提问澄清;若缺少必要输入、文件或工具,须报告缺失并询问是否提供安装指导。具体价格、平台支持范围等资料暂未提供。