mcpField
1
170-java-documentation

170-java-documentation

github.com/jabrena开发456363 次安装1 天前更新
代码仓库

关于 170-java-documentation

面向 Java 项目的交互式文档生成技能，通过可配置步骤创建或完善文档，涵盖 Maven README、package-info.java 和 Javadoc，并提供文件处理选项与文档验证。

主要功能

  1. 01生成单模块或多模块 Maven README
  2. 02按详细程度创建 package-info.java
  3. 03完善 Javadoc 参数、返回值和异常标签
  4. 04支持覆盖、追加、备份或跳过文件
  5. 05编译与 Javadoc 验证检查

适用场景

  1. 01为 Maven 项目生成 README
  2. 02使用 package-info.java 编写包文档
  3. 03通过 Javadoc 完善 Java API 文档

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/jabrena/plinth --skill 170-java-documentation

安装后在 Claude Code 中输入/170-java-documentation确认已加载。

附带文件references/170-java-documentation.md

详细介绍

采用模块化分步配置的 Java 文档生成器

通过模块化、分步交互流程生成全面的 Java 项目文档，涵盖 README.md、package-info.java 和 Javadoc。这是一个交互式 SKILL。

此 Skill 涵盖哪些内容？

  • 为单模块和多模块 Maven 项目生成 README.md
  • 创建 package-info.java，并提供基础、详细和精简文档级别
  • 增强 Javadoc：补充全面的 @param/@return/@throws 标签
  • 文件处理策略：覆盖/添加/备份/跳过
  • 使用 ./mvnw clean compile 和 ./mvnw javadoc:javadoc 进行最终文档验证

约束

开始生成任何文档之前，先确保项目通过验证。如果验证失败，立即停止；在解决所有验证错误之前，不要继续。

  • 强制要求：生成任何文档之前，先运行 ./mvnw validate 或 mvn validate
  • 安全要求：如果验证失败，立即停止；在解决所有验证错误之前，不要继续
  • 开始操作前：阅读参考文档，了解每种文档生成模式的详细正反示例、约束和安全措施
  • 边缘情况：如果请求范围不明确，先停止并提出澄清问题，再进行更改
  • 边缘情况：如果缺少必需的输入、文件或工具，请说明缺少的内容，并询问是否需要提供设置指导

何时使用此 Skill

  • 为代码添加文档以提升代码质量
  • 应用文档
  • 在完善文档的同时重构代码
  • 为 Java 项目生成 README 或开发者文档
  • 编写 Java API 架构或项目工作流文档

工作流

  1. 在修改文档前验证项目

运行 ./mvnw validate 或 mvn validate；如果验证失败，立即停止。

  1. 阅读文档参考并明确范围

阅读 references/170-java-documentation.md，并确定所需的输出（README、package-info、Javadoc 增强）。

  1. 生成选定的文档产物

使用选定的文件处理策略（覆盖/添加/备份/跳过）创建或更新文档。

  1. 运行文档验证检查

执行 ./mvnw clean compile 和 ./mvnw javadoc:javadoc（或等效命令）来验证生成的文档。

参考

详细指南、示例和约束请参阅 references/170-java-documentation.md。

评论

支持 Markdown