2011-05-24 54 views

回答

3

您可以使用Checkstyle。但是,標準檢查(sun編碼標準)相當嚴格,您可能希望從用於配置的XML中刪除一些檢查,具體取決於您的口味

1

雖然像Checkstyle這樣的工具可以檢查遵守風格約定,他們不應該被用來評估文件。是的,checkstyle可以檢查文檔是否存在,但不是說這個文檔是正確的或者是有用的 - 而且無用的文檔比沒有文檔更糟糕,因爲它至少不會混淆源代碼。例如,CheckStyle的會考慮:

​​

會更好(因爲存在的意見,所有參數和返回值都記錄),比

/** 
* @return the amount of this transaction (positive for deposits, negative for withdrawals) 
*/ 
BigDecimal getAmount() { 
    return amount; 
} 


/** 
* @see #getAmount() 
*/ 
void setAmount(BigDecimal amount) { 
    this.amount = amount; 
} 

因爲後者不會記錄方法的參數..

簡而言之,這些文檔是足夠的,不能通過機器來驗證,而且容易獲得的度量標準只顯示圖片的一部分 - 在我看來這是一個很不相關的部分。