code-comment-standard

To enforce consistent Java code comments, apply standardized templates for class, method, and field levels using Javadoc conventions. This ensures readability and maintainability across the entire project by targeting specific documentation levels with structured guidance and exemplars.

The best way to format Javadoc is using standardized templates for class-level, method-level, and field-level documentation. It includes practical examples and conventions for inline notes, TODO, and WARNING comments to maintain code clarity.

Keep Java documentation synchronized during code refactors by following practical examples and notes on maintaining consistent comments. Updated Javadoc must reflect refactored logic to ensure class and method documentation remains fully aligned.

Use Javadoc for class-level, method-level, and field-level documentation to provide structured API clarity, whereas use inline comments for specific TODO, NOTE, or WARNING conventions inside the code logic to ensure maintainability.

Yes, this Java commenting standard requires a YAML frontmatter name and description in the SKILL.md file. This configuration defines the standardized comment types and formats applied across the Java project to enforce documentation rules.