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.
Verwenden Sie es, wenn Sie Java-Projektdokumentation generieren oder verbessern müssen – einschließlich README.md-Dateien, package-info.java-Dateien und Javadoc-Erweiterungen – durch einen modularen, schrittbasierten interaktiven Prozess, der sich an Ihre spezifischen Dokumentationsanforderungen anpasst. Teil des Skills-for-Java-Projekts Quelle: jabrena/cursor-rules-java.