如何解決checkstyle_error.xml錯誤

Question

在我的項目中，checkstyle_error.xml顯示此錯誤Parameter role should be final.

for public void setRole(String role) {但我不明白為什么它應該是最終的。 並可能會有更多空間和Tab字符相關的錯誤。 誰能告訴我為什么。 任何好的方法來查找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錯誤消息時，查看檢查列表可能會有所幫助，例如有關空白的規則 。

• 為什么要使用最終參數 ：

  這是一種防止錯誤更改參數值的隱患的簡便方法。 一般而言，短方法是防止此類錯誤的更好方法，但是最終參數可能是編碼風格的有用補充。

• 為什么您不想使用制表符 ：

  開發人員無需配置文本編輯器的制表符寬度即可讀取源代碼。

• 如何編寫Javadoc注釋 1： @param id your comment goes here而不是@param Integer id 。 錯誤消息指出，當沒有這樣的參數時，對於名為Integer的參數有一個@param標記。

• 如何編寫Javadoc注釋2：您的方法缺少任何Javadoc，尤其是id參數的@param標記（這就是錯誤消息所顯示的內容）。

Answer 2

它想要：

public void setRole(final String role)

因為您永遠不會重新分配role變量。 我認為這有點苛刻，大多數樣式指南都不需要。 通常 ，參數是最終的，如果不是 ，我可能希望發表評論。 但是，使用final關鍵字確實增加了一些清晰度。