Documentation should be complete, accurate, and follow Spring Framework conventions. Ensure your Javadocs include:
- Clear and accurate descriptions that precisely explain behavior and purpose
```java
/**
- Complete parameter documentation for all parameters, especially in interfaces
```java
/**
- Called before every retry attempt.
- @param retryExecution the current retry execution context
*/
default void beforeRetry(RetryExecution retryExecution) {
```
-
Class-level Javadoc for all public classes and interfaces
- Format standards:
- Wrap Javadoc around 90 characters
- Don’t end
@param
or @return
descriptions with periods unless they contain sentences
- Include
@since
tags for all new public methods
- Contextual information about when and how to use the API:
```java
/**
- Create a builder with the method, URI, headers, cookies, attributes, and body of the given request.
- @param other the request to copy the method, URI, headers, cookies, attributes, and body from
- @return the created builder
- @since 5.3
*/
```
- Clear behavioral documentation for methods with special handling:
```java
/**
Documentation should be specific to the code at hand rather than copied from similar classes, and should clarify edge cases and expected behaviors.
Add Repository
Enter the URL of a public GitHub repository