2011-10-08 136 views
0

在我的項目checkstyle_error.xml顯示此錯誤Parameter role should be final.如何解決checkstyle_error.xml錯誤

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

一個最佳實踐是讓參數成爲'final'。 代碼更容易閱讀,因爲它會阻止方法內的代碼更改引用:即'role ='other''將被禁止。 – YMomb

回答

0

它想:

public void setRole(final String role) 

,因爲你永遠不會重新分配role變量。我認爲這是有點苛刻,大多數風格指南不需要它。在一般,參數是最終的,如果它不是,我可能會有一個評論。但是,它的確使用final關鍵字增加了一點清晰度。

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。錯誤消息表明,當沒有這樣的參數時,稱爲Integer的參數有@param標記。

  • 如何編寫Javadoc註釋2:你的方法缺少任何的Javadoc,尤其是@param標籤爲id參數(這是錯誤消息說的話)。