SuperAPI AI 工具集

170-java-documentation

编程与开发

查看项目

更新于 10-16 10:57

技能介绍

用途

本技能用于生成或改进 Java 项目文档,涵盖 README.md、package-info.java 与 Javadoc 增强。它是一个交互式 SKILL,采用模块化、分步骤的配置流程,按用途可归纳为:为 Java 项目生成或完善 README 与开发者文档、为代码补充文档、重构代码时同步文档,以及记录 Java API 架构或项目工作流。

主要能力

  • README.md 生成:支持单模块与多模块 Maven 项目。
  • package-info.java 创建:提供基础、详细、最小三种文档级别。
  • Javadoc 增强:补全 @param、@return、@throws 等标签。
  • 文件处理策略:可选择覆盖、追加、备份或跳过。
  • 最终文档校验:通过 ./mvnw clean compile 与 ./mvnw javadoc:javadoc 验证生成的文档。

使用方式

工作流为分步骤执行:

  1. 在文档变更前验证项目。运行 ./mvnw validate 或 mvn validate,若验证失败必须立即停止。
  2. 阅读文档参考并收集范围。查阅 references/170-java-documentation.md,确定需要的输出(README、package-info、Javadoc 增强)。
  3. 生成选定的文档产物。使用选定的文件处理策略(覆盖/追加/备份/跳过)创建或更新文档。
  4. 运行文档校验检查。执行 ./mvnw clean compile 与 ./mvnw javadoc:javadoc(或等价命令)验证生成的文档。

约束与注意事项

  • 在应用任何文档生成之前,确保项目可通过验证。若验证失败,立即停止,直到所有验证错误解决后再继续。
  • 强制要求:在应用任何文档生成之前运行 ./mvnw validate 或 mvn validate。
  • 安全要求:若验证失败立即停止。
  • 应用之前:阅读参考文档,了解每种文档生成模式的详细正反示例、约束与防护措施。
  • 边界情况:若请求范围不明确,停止并提出澄清问题后再应用变更。
  • 边界情况:若缺少必要输入、文件或工具,报告缺失内容并询问是否提供设置指引。

适用场景

改善代码文档、为代码补充文档、在重构代码时同步文档、为 Java 项目生成 README 或开发者文档、记录 Java API 架构或项目工作流。

限制

该技能依赖 Maven 项目环境与 ./mvnw 或 mvn 命令;具体支持的编辑范围、更多配置项及与其他工具集成能力,资料中暂未提供。