|
Java中的命名規(guī)則
在面向?qū)ο缶幊讨?，對于類,，對象，方法,，變量等方面的命名是非常有技巧的,。比如，大小寫的區(qū)分,，使用不同字母開頭等等,。但究其本，追其源,，在為一個資源其名稱的時候,，應該本著描述性以及唯一性這兩大特征來命名，才能保證資源之間不沖突,，并且每一個都便于記憶。
包的命名
Java包的名字都是由小寫單詞組成,。但是由于Java面向?qū)ο缶幊痰奶匦?，每一名Java程序員都可以編寫屬于自己的Java包，為了保障每個Java包命名的唯一性,，在最新的Java編程規(guī)范中,，要求程序員在自己定義的包的名稱之前加上唯一的前綴。由于互聯(lián)網(wǎng)上的域名稱是不會重復的,，所以程序員一般采用自己在互聯(lián)網(wǎng)上的域名稱作為自己程序包的唯一前綴,。
例如： net.frontfree.javagroup
類的命名
類的名字必須由大寫字母開頭而單詞中的其他字母均為小寫；如果類名稱由多個單詞組成,，則每個單詞的首字母均應為大寫例如TestPage,；如果類名稱中包含單詞縮寫，則這個所寫詞的每個字母均應大寫,，如：XMLExample,還有一點命名技巧就是由于類是設(shè)計用來代表對象的,，所以在命名類時應盡量選擇名詞。
例如： Circle
方法的命名
方法的名字的第一個單詞應以小寫字母作為開頭,，后面的單詞則用大寫字母開頭,。
例如： sendMessge
常量的命名
常量的名字應該都使用大寫字母，并且指出該常量完整含義,。如果一個常量名稱由多個單詞組成,，則應該用下劃線來分割這些單詞,。
例如： MAX_VALUE
參數(shù)的命名
參數(shù)的命名規(guī)范和方法的命名規(guī)范相同，而且為了避免閱讀程序時造成迷惑,，請在盡量保證參數(shù)名稱為一個單詞的情況下使參數(shù)的命名盡可能明確,。
Javadoc注釋
Java除了可以采用我們常見的注釋方式之外，Java語言規(guī)范還定義了一種特殊的注釋,，也就是我們所說的Javadoc注釋,，它是用來記錄我們代碼中的API的。Javadoc注釋是一種多行注釋,，以結(jié)束,，注釋可以包含一些HTML標記符和專門的關(guān)鍵詞。使用Javadoc注釋的好處是編寫的注釋可以被自動轉(zhuǎn)為在線文檔,，省去了單獨編寫程序文檔的麻煩,。
例如：
在每個程序的最開始部分，一般都用Javadoc注釋對程序的總體描述以及版權(quán)信息,，之后在主程序中可以為每個類,、接口、方法,、字段添加Javadoc注釋,，每個注釋的開頭部分先用一句話概括該類、接口,、方法,、字段所完成的功能，這句話應單獨占據(jù)一行以突出其概括作用,，在這句話后面可以跟隨更加詳細的描述段落,。在描述性段落之后還可以跟隨一些以Javadoc注釋標簽開頭的特殊段落，例如上面例子中的@auther和@version,，這些段落將在生成文檔中以特定方式顯示,。
雖然為一個設(shè)計低劣的程序添加注釋不會使其變成好的程序，但是如果按照編程規(guī)范編寫程序并且為程序添加良好的注釋卻可以幫助你編寫出設(shè)計完美,，運行效率高且易于理解的程序,，尤其是在多人合作完成同一項目時編程規(guī)范就變得更加重要。俗話說“磨刀不誤砍柴工”,，花費一點時間去適應一下Java編程規(guī)范是有好處的,。
|
