1ba5cc78ff
* new java and springboot base best practices * Update java-and-springboot.md * Update java-and-springboot.md * split java and springboot instructions * header wrap with signle quote * remove duplicate instruction * address code reviews * apply update-readme script * java and kotlin prompts for springboot * apply update-readme script * Apply suggestion from @aaronpowell --------- Co-authored-by: Aaron Powell <me@aaron-powell.com>
25 lines
1.5 KiB
Markdown
25 lines
1.5 KiB
Markdown
---
|
|
mode: 'agent'
|
|
tools: ['changes', 'codebase', 'editFiles', 'problems']
|
|
description: 'Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.'
|
|
---
|
|
|
|
# Java Documentation (Javadoc) Best Practices
|
|
|
|
- Public and protected members should be documented with Javadoc comments.
|
|
- It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory.
|
|
- The first sentence of the Javadoc comment is the summary description. It should be a concise overview of what the method does and end with a period.
|
|
- Use `@param` for method parameters. The description starts with a lowercase letter and does not end with a period.
|
|
- Use `@return` for method return values.
|
|
- Use `@throws` or `@exception` to document exceptions thrown by methods.
|
|
- Use `@see` for references to other types or members.
|
|
- Use `{@inheritDoc}` to inherit documentation from base classes or interfaces.
|
|
- Unless there is major behavior change, in which case you should document the differences.
|
|
- Use `@param <T>` for type parameters in generic types or methods.
|
|
- Use `{@code}` for inline code snippets.
|
|
- Use `<pre>{@code ... }</pre>` for code blocks.
|
|
- Use `@since` to indicate when the feature was introduced (e.g., version number).
|
|
- Use `@version` to specify the version of the member.
|
|
- Use `@author` to specify the author of the code.
|
|
- Use `@deprecated` to mark a member as deprecated and provide an alternative.
|