java命名規範

1．包的命名

Java包的名字都是由小寫單片語成。每一名Java程式設計師都可以編寫屬於自己的Java包，為了保障每個Java包命名的惟一性，最新的Java程式設計規範要求程式設計師在自己定義的包的名稱之前加上惟一的字首。由於網際網路上的域名是不會重複的，所以程式設計師一般採用自己在網際網路上的域名作為自己程式包的惟一字首。

例如：net.frontfree.javagroup。

2．類的命名

類的名字必須由大寫字母開頭，一個單詞中的其他字母均為小寫。如果類名稱由多個單片語成，則建議將每個單詞的首字母均用大寫，例如TestPage。如果類名稱中包含單詞縮寫，則建議將這個詞的每個字母均用大寫，如：XMLExample。由於類是設計用來代表物件的，所以建議在命名類時應儘量選擇名詞。

3．方法的命名

方法的名字的第1個單詞應以小寫字母開頭，後面的單詞則建議用大寫字母開頭。

例如：sendMessge()。

4．常量的命名

常量的名字應該都使用大寫字母，並且指出該常量完整含義。如果一個常量名稱由多個單片語成，則建議用下劃線來分割這些單詞。

例如：MAX_VALUE。

5．引數的命名

引數的命名規範和方法的命名規範相同，而且為了避免閱讀程式時造成迷惑，請在儘量保證在引數名稱為一個單詞的情況下，引數的命名儘可能明確。

6．Javadoc註釋

Java除了可以採用常見的註釋方式之外，Java語言規範還定義了一種特殊的註釋，也就是通常所說的Javadoc註釋，它是用來記錄程式碼中的API的。Javadoc註釋是一種多行註釋，以/**開頭，而以*/結束，註釋可以包含一些HTML標記符和專門的關鍵詞。使用Javadoc註釋的好處是編寫的註釋可以被自動轉化為線上文件，省去了單獨編寫程式文件的麻煩。例如：

/** *This is an example of * Javadoc * *@author darchon *@version 0.1, 10/11/2002 */ 在每個程式的最開始部分，一般都用Javadoc註釋進行程式的總體描述以及版權資訊。在主程式中可以為每個類、介面、方法、變數新增Javadoc註釋，每個註釋的開頭部分先用一句話概括該類、介面、方法、變數所完成的功能，這句話應單獨佔據一行以突出其概括作用，在這句話後面可以跟隨更加詳細的描述段落。

在描述性段落之後還可以跟隨一些以Javadoc註釋標籤開頭的特殊段落，例如上面例子中的@auther和@version，這些段落將在生成的文件中以特定方式顯示。

雖然新增註釋不會使一個設計低劣的程式變成好的程式，但是如果按照程式設計規範編寫程式，並且為程式新增良好的註釋，卻可以幫助編寫出設計優美、執行高效且易於理解的程式，尤其在多人合作完成同一專案時，程式設計規範非常重要。俗話說"磨刀不誤砍柴工"，花費一點時間去適應一下Java程式設計規範是有好處的。

例：