как устранить ошибки checkstyle_error.xml

Question

В моем проекте checkstyle_error.xml показывает эту ошибку Parameter role should be final.

для public void setRole(String role) {, но я не понимаю, почему это должно быть окончательно. И, возможно, больше места и вкладка char связана с ошибкой. Кто-нибудь может сказать мне, почему это. любой хороший учебник, чтобы найти соглашение об ошибке в стиле контрольного стиля.

я получил еще несколько ошибок:

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

• Всякий раз, когда вы не понимаете сообщение об ошибке контрольного стиля, может оказаться полезным просмотр списка проверок , например, правил, касающихся пробелов .

• Почему вы хотите использовать конечные параметры :

  Это удобный способ защиты от коварной ошибки, которая ошибочно изменяет значение ваших параметров,Вообще говоря, короткие методы являются лучшим способом защиты от этого класса ошибок, но конечные параметры могут быть полезным дополнением к вашему стилю кодирования.

• Почему вы не хотите использовать символы табуляции :

  Разработчикам не нужно настраивать ширину табуляцииих текстовых редакторов, чтобы иметь возможность читать исходный код.

• Как писать комментарии Javadoc 1: @param id your comment goes here вместо @param Integer id,В сообщении об ошибке говорится, что существует параметр @param для параметра с именем Integer, когда такого параметра нет.

• Как писать комментарии Javadoc 2: Ваш метод отсутствуетлюбой Javadoc, особенно тег @param для параметра id (это то, что говорится в сообщении об ошибке).

Answer 2

хочет:

public void setRole(final String role)

, поскольку вы никогда не переназначаете переменную role. Я думаю, что это немного требовательно, и большинству руководств по стилю это не требуется. В general параметры являются окончательными, и я мог бы ожидать комментарий, если бы он не был. Однако, это добавляет немного ясности использованию ключевого слова final.