JAVA程式設計 第八章編程規範和JAVADoc

綱要：

1、編程規範：規範的編程習慣有助於程式的理解和維護。

       a、命名規範：包的命名一般採用網域名稱逆序，名稱全部小寫；檔案的名稱與public類同名；類與介面的命名名詞片語每個單字首大寫其餘小寫，要求使用全稱用詞準確簡單；方法的命名動詞片語只有中間單字首大寫。欄位的命名名詞片語中間單字首大寫其餘小寫，從資料功能出發，簡練準確；常量命名字母全部大寫中間使用底線；

       b、編輯規範：tab一般禁止使用，因為不同的OS有不同的長度解釋；一般檔案不要超過2000行，每行不超過80個字元；推薦採用四空格縮排方式；分行要考慮邏輯關係；類和類之間兩個空白行；方法之間插一個空白行；方法和欄位定義之間插一個空白行；局部變數和第一個語句間插一個空白行；方法中的邏輯塊插一個空白行(基本上只有類和類間插兩個空白行，類的內部也是按邏輯只差一個空白行，在方法體內按邏輯分塊，每塊間只插一個空白行)；

       c、注釋：總體介紹功能，詳細介紹約束條件，避免對簡單語句解釋；檔案組織：一般按如下順序：注釋，package，import，類或介面的定義；檔案的注釋一般包括：類的名字作者著作權日期版本及檔案本省描述；類和介面的定義：類和介面的文檔注釋/** */;優先定義public 然後protected最後是private域。方法定義：每個方法前都要有文檔注釋/**<detailed desc>   *@param <> *@return <> *@excetpion<> *@author<>*/

2、JAVADoc: javadoc是從程式提取文檔注釋/**  */產生HTML協助檔案的工具。

     格式/** description

               *@tag

               */

     常用tag標籤有@author @return @param@throws @see @version @since @link @deprecated

     使用方法：javadoc -d  .   -author   Time2.java