Question

在我的项目中，checkstyle_error.xml显示此错误Parameter role should be final.

public void setRole(String role) {，但我不明白为什么它应该是最终的。并且可能会有更多空格和tab char相关的错误。任何人都可以告诉我为什么会这样。任何找到checkstyle错误约定的好教程。

我得到的更多错误是：

1.   Unused @param tag for &apos;Integer&apos; 


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

2.    Expected @param tag for &apos;id&apos



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

Answer 1

每当您不理解checkstyle错误消息时，查看list of checks可能会有所帮助，例如： rules concerning whitespace
为什么要使用final parameters：

这是一种方便的方法来防止错误地改变参数值的阴险错误。一般来说，简短方法是防止这类错误的更好方法，但最终参数可以成为编码风格的有用补充。
为什么您不想使用tab characters：

开发人员不需要配置文本编辑器的标签宽度，以便能够阅读源代码。
How to write Javadoc comments 1：@param id your comment goes here代替@param Integer id。如果没有此类参数，则会显示一条名为@param的参数的Integer标记错误消息。
如何编写Javadoc注释2：您的方法缺少任何Javadoc，尤其是@param参数的id标记（这就是错误消息所说的内容）。
< / LI>

Answer 2

它想要：

public void setRole(final String role)

因为您永远不会重新分配role变量。我认为这有点苛刻，大多数风格指南都不需要它。在 general 中，参数是最终的，如果不是，我可能会期待评论。但是，它确实添加了一点清晰度来使用final关键字

如何解决checkstyle_error.xml错误

2 个答案: