非區域性 的資訊

非區域性 的資訊

非區域性 的資訊

非區域性 的資訊

若要寫註解，要確保它只會用來描述附近的程式碼。不要

在一個區域性的註解裡，提供整個系統的全域資訊。例如，

例子的Javadoc註解，它是個可怕的冗餘。它提供了預設

連接埠的資訊，這是個離題的事實，因程式沒有控制預設值，

代表這個註解不是用來說明此函式，而是另一個系統離這個

區塊很遠的函式。

/ **

• Port on which fitnesse would run. Defaults to 8082.
• @param fitnessePort
  */
  public void setFitnessePort(int fitnessePort)
  {
  this.fitnessePort = fitnessePort;
  }