java - 我应该如何记录参数 "says"？

Question

无法解决问题:\我应该如何记录第二个参数“says”？因为 SonarQube 一次又一次地问我这个问题。

public class Dogs {

    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(Dogs.class);
    private final String                  name;
    private final String                  says;

    /**
     * The Dogs class.
     *
     * @param name
     *            says. // here the problem
     *
     */
    public Dogs(final String name, final String says) {
        this.name = name;
        this.says = says;
    }

}  

Answer 1

你应该在参数名前面加上@param，像这样:

/**
 * The Dogs class.
 *
 * @param name explain what is it ! 
 * @param says explain what is it !
 *
 */
public Dogs(final String name, final String says) {
    this.name = name;
    this.says = says;
}