What problem does it solve?
This Skill automates the generation and validation of Javadoc comments for Java classes, ensuring that all necessary documentation is complete and correctly formatted, saving developers time and reducing the risk of documentation gaps.
Core Features & Use Cases
- Javadoc Generation: Automatically generate Javadoc comments based on the source code, including methods, classes, interfaces, and enums.
- Scope Determination: Supports invocation with specific class names or file paths, or by default, covers classes changed in the current branch.
- Package-Level Documentation: Ensures that each package has a complete
package-info.java file, enhancing project maintainability.
- Build Verification: Validates the generated Javadoc through the project's build process to ensure compliance with coding standards.
Quick Start
Run the java-javadoc skill with the class name you want to document: /java-javadoc MyClass