Java how to put comments on swagger documentation in spring boot

To add comments to your Swagger documentation in a Spring Boot application, you can use the @ApiModelProperty annotation on the fields or getter methods of your model classes. The @ApiModelProperty annotation allows you to specify a description for each field or property, which will be included in the Swagger documentation.

Here is an example of how you can add comments to your Swagger documentation in a Spring Boot application:

import io.swagger.annotations.ApiModelProperty;

public class User {
    @ApiModelProperty(value = "The user's first name")
    private String firstName;

    @ApiModelProperty(value = "The user's last name")
    private String lastName;

    @ApiModelProperty(value = "The user's email address")
    private String email;

    // Getters and setters for the fields
}

In this example, the User class has three fields: firstName, lastName, and email. Each field is annotated with the @ApiModelProperty annotation and has a description specified in the value attribute.

When you generate the Swagger documentation for your Spring Boot application, the descriptions for the fields will be included in the documentation, along with the field names and types.

Keep in mind that this is just one way to add comments to your Swagger documentation in a Spring Boot application. You can use different annotations and techniques to specify additional information and customize the appearance of the documentation, such as using the @ApiModel annotation to specify a description for the model class or using the @ApiOperation annotation to add comments to the API operations.