170-java-documentation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Java Documentation Generator with modular step-based configuration

基于模块化分步配置的Java文档生成器

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.

What is covered in this Skill?

README.md generation for single-module and multi-module Maven projects
package-info.java creation with basic/detailed/minimal documentation levels
Javadoc enhancement: comprehensive
```
@param
```
/
```
@return
```
/
```
@throws
```
tags
File handling strategies: overwrite/add/backup/skip

Final documentation validation with

./mvnw clean compile

and

./mvnw javadoc:javadoc

通过一个模块化、分步式的交互式流程生成全面的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

进行最终文档验证

Constraints

约束条件

Before applying any documentation generation, ensure the project validates. If validation fails, stop immediately — do not proceed until all validation errors are resolved.

MANDATORY: Run
```
./mvnw validate
```
or
```
mvn validate
```
before applying any documentation generation
SAFETY: If validation fails, stop immediately — do not proceed until all validation errors are resolved
BEFORE APPLYING: Read the reference for detailed good/bad examples, constraints, and safeguards for each documentation generation pattern

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

强制要求：在生成任何文档前，运行
```
./mvnw validate
```
或
```
mvn validate
```
安全提示：如果验证失败，请立即停止——在所有验证错误解决前不要继续
使用前须知：阅读参考文档，了解每种文档生成模式的详细优劣示例、约束条件和防护措施

When to use this skill

何时使用本Skill

Improve the code with documentation
Apply documentation
Refactor the code with documentation

为代码添加或改进文档
应用文档生成
通过文档重构代码

Reference

参考资料

For detailed guidance, examples, and constraints, see references/170-java-documentation.md.

如需详细指南、示例和约束条件，请查看references/170-java-documentation.md。