java - 如何解决 checkstyle_error.xml 错误

Question

在我的项目中 checkstyle_error.xml 显示此错误参数角色应该是最终的。

for public void setRole(String role) { 但我不明白为什么它应该是最终的。并且可能会出现更多空格和制表符相关的错误。谁能告诉我这是为什么。有什么好的教程可以找到 checkstyle 错误约定。

我遇到的更多错误是:

1.   Unused @param tag for 'Integer' 


     /**
         *  Sets id.
         *  @param Integer id
         */
        public void setId(Integer id) {
            this.id = id;
        }

2.    Expected @param tag for 'id&apos



    public void setId(Integer id) {
            this.id = id;
        }

Answer 1

• 每当您不理解 checkstyle 错误消息时，请查看 list of checks可能会有所帮助，例如rules concerning whitespace .

• 为什么要使用 final parameters :

  It's a handy way to protect against an insidious bug that erroneously changes the value of your parameters. Generally speaking, short methods are a better way to protect from this class of errors, but final parameters can be a useful addition to your coding style.

• 为什么你不想使用tab characters :

  Developers should not need to configure the tab width of their text editors in order to be able to read source code.

• How to write Javadoc comments 1:@param id 您的评论位于此处，而不是 @param Integer id。错误消息指出，当没有名为 Integer 的参数时，有一个 @param 标记。

• 如何编写 Javadoc 注释 2:您的方法缺少任何 Javadoc，尤其是 id 参数的 @param 标记(这就是错误消息的内容) )。