如何解决 checkstyle_error.xml 错误

发布于 2024-12-08 18:55:12 字数 581 浏览 0 评论 0原文

在我的项目中,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;
        }

In my project checkstyle_error.xml shows this error Parameter role should be final.

for public void setRole(String role) { but i am not getting why it should be final.
And may more space and tab char related error. can any one tell me why is this. any good tutorial to find checkstyle error convention.

some more errors i got are:

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;
        }

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

灼疼热情 2024-12-15 18:55:12
  • 每当您不理解 checkstyle 错误消息时,请查看检查列表可能会有所帮助,例如有关空格的规则

  • 为什么要使用最终参数:< /p>
    <块引用>

    这是一种防止错误更改参数值的潜在错误的便捷方法。一般来说,短方法是防止此类错误的更好方法,但最终参数可以为您的编码风格提供有用的补充。

  • 为什么你不想使用制表符

    <块引用>

    开发人员无需配置文本编辑器的制表符宽度即可读取源代码。

  • 如何编写Javadoc注释 1: @param id 您的评论位于此处,而不是 @param Integer id。错误消息指出,当没有名为 Integer 的参数时,有一个 @param 标记。

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

  • Whenever you don't understand a checkstyle error message, looking at the list of checks may be helpful, e.g. rules concerning whitespace.

  • Why you want to use 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.

  • Why you don't want to use 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 your comment goes here instead of @param Integer id. The error message says that there is a @param tag for a parameter called Integer, when there is no such parameter.

  • How to write Javadoc comments 2: Your method is missing any Javadoc, especially a @param tag for the id parameter (that's what the error message says).

停顿的约定 2024-12-15 18:55:12

它想要:

public void setRole(final String role)

因为你永远不会重新分配 role 变量。我认为这有点苛刻,大多数风格指南都不会要求它。在一般中,参数是最终的,如果不是,我可能会期待一个注释。但是,它确实增加了使用final的清晰度。代码>关键字。

It wants:

public void setRole(final String role)

since you never reassign the role variable. I think this is a bit demanding, and most style guides would not require it. In general, parameters are final, and I might expect a comment if it wasn't. However, it does add a little clarity to use the final keyword.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文