·170-java-documentation
""

170-java-documentation

当您需要通过适应您的特定文档需求的模块化、基于步骤的交互过程来生成或改进 Java 项目文档(包括 README.md 文件、package-info.java 文件和 Javadoc 增强功能)时使用。 java 技能项目的一部分

14安装·3热度·@jabrena

安装

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

如何安装 170-java-documentation

通过命令行快速安装 170-java-documentation AI 技能到你的开发环境

  1. 打开终端: 打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等)
  2. 运行安装命令: 复制并运行以下命令:npx skills add https://github.com/jabrena/cursor-rules-java --skill 170-java-documentation
  3. 验证安装: 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code、Cursor 或 OpenClaw 中使用

来源:jabrena/cursor-rules-java。

SKILL.md

查看原文

Generate comprehensive Java project documentation through a modular, step-based interactive process that covers README.md, package-info.java, and Javadoc. This is an interactive SKILL.

Prerequisites: Run ./mvnw validate or mvn validate before applying any documentation generation. If validation fails, stop immediately — do not proceed until all validation errors are resolved.

Core areas: README.md generation for single-module and multi-module Maven projects, package-info.java creation with basic/detailed/minimal documentation levels, Javadoc enhancement with comprehensive @param/@return/@throws tags, file handling strategies (overwrite/add/backup/skip), and final documentation validation with ./mvnw clean compile and ./mvnw javadoc:javadoc.

当您需要通过适应您的特定文档需求的模块化、基于步骤的交互过程来生成或改进 Java 项目文档(包括 README.md 文件、package-info.java 文件和 Javadoc 增强功能)时使用。 java 技能项目的一部分 来源:jabrena/cursor-rules-java。

可引用信息

为搜索与 AI 引用准备的稳定字段与命令。

安装命令
npx skills add https://github.com/jabrena/cursor-rules-java --skill 170-java-documentation
分类
""沟通写作
认证
收录时间
2026-03-10
更新时间
2026-03-10

Browse more skills from jabrena/cursor-rules-java

快速解答

什么是 170-java-documentation?

当您需要通过适应您的特定文档需求的模块化、基于步骤的交互过程来生成或改进 Java 项目文档(包括 README.md 文件、package-info.java 文件和 Javadoc 增强功能)时使用。 java 技能项目的一部分 来源:jabrena/cursor-rules-java。

如何安装 170-java-documentation?

打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/jabrena/cursor-rules-java --skill 170-java-documentation 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code、Cursor 或 OpenClaw 中使用

这个 Skill 的源码在哪?

https://github.com/jabrena/cursor-rules-java