規定型註解

規定型註解

規定型註解

規定型註解

若有規則規定每個函式都必須有一個Javadoc，或
每個變數都應該要有註解來說明，像這樣的註解只
會讓程式碼更加凌亂。進而產生更多困惑和製造散亂
的程式結構。

example:
/**
*

• @param title The title of the CD
• @param author The author of the CD
• @param tracks The number of tracks on the CD
• @param durationInMinutes The duration of the CD in minutes
  */
  public void addCD(…) {
  …
  }