Java中的命名規(guī)則

橙zc 2014-09-04

展開(kāi)全文

Java中的命名規(guī)則

　　在面向?qū)ο缶幊讨校瑢?duì)于類，對(duì)象，方法，變量等方面的命名是非常有技巧的。比如，大小寫(xiě)的區(qū)分，使用不同字母開(kāi)頭等等。但究其本，追其源，在為一個(gè)資源其名稱的時(shí)候，應(yīng)該本著描述性以及唯一性這兩大特征來(lái)命名，才能保證資源之間不沖突，并且每一個(gè)都便于記憶。

包的命名　

　　Java包的名字都是由小寫(xiě)單詞組成。但是由于Java面向?qū)ο缶幊痰奶匦?，每一名Java程序員都可以編寫(xiě)屬于自己的Java包，為了保障每個(gè)Java包命名的唯一性，在最新的Java編程規(guī)范中，要求程序員在自己定義的包的名稱之前加上唯一的前綴。由于互聯(lián)網(wǎng)上的域名稱是不會(huì)重復(fù)的，所以程序員一般采用自己在互聯(lián)網(wǎng)上的域名稱作為自己程序包的唯一前綴。

　　例如： net.frontfree.javagroup

類的命名

　　類的名字必須由大寫(xiě)字母開(kāi)頭而單詞中的其他字母均為小寫(xiě)；如果類名稱由多個(gè)單詞組成，則每個(gè)單詞的首字母均應(yīng)為大寫(xiě)例如TestPage；如果類名稱中包含單詞縮寫(xiě)，則這個(gè)所寫(xiě)詞的每個(gè)字母均應(yīng)大寫(xiě)，如：XMLExample,還有一點(diǎn)命名技巧就是由于類是設(shè)計(jì)用來(lái)代表對(duì)象的，所以在命名類時(shí)應(yīng)盡量選擇名詞。　　

　　例如： Circle

方法的命名

　　方法的名字的第一個(gè)單詞應(yīng)以小寫(xiě)字母作為開(kāi)頭，后面的單詞則用大寫(xiě)字母開(kāi)頭。

　　例如： sendMessge

常量的命名

　　常量的名字應(yīng)該都使用大寫(xiě)字母，并且指出該常量完整含義。如果一個(gè)常量名稱由多個(gè)單詞組成，則應(yīng)該用下劃線來(lái)分割這些單詞。

　　例如： MAX_VALUE

參數(shù)的命名

　　參數(shù)的命名規(guī)范和方法的命名規(guī)范相同，而且為了避免閱讀程序時(shí)造成迷惑，請(qǐng)?jiān)诒M量保證參數(shù)名稱為一個(gè)單詞的情況下使參數(shù)的命名盡可能明確。

Javadoc注釋

　　Java除了可以采用我們常見(jiàn)的注釋方式之外，Java語(yǔ)言規(guī)范還定義了一種特殊的注釋，也就是我們所說(shuō)的Javadoc注釋，它是用來(lái)記錄我們代碼中的API的。Javadoc注釋是一種多行注釋，以結(jié)束，注釋可以包含一些HTML標(biāo)記符和專門(mén)的關(guān)鍵詞。使用Javadoc注釋的好處是編寫(xiě)的注釋可以被自動(dòng)轉(zhuǎn)為在線文檔，省去了單獨(dú)編寫(xiě)程序文檔的麻煩。

　　例如：

　　在每個(gè)程序的最開(kāi)始部分，一般都用Javadoc注釋對(duì)程序的總體描述以及版權(quán)信息，之后在主程序中可以為每個(gè)類、接口、方法、字段添加Javadoc注釋，每個(gè)注釋的開(kāi)頭部分先用一句話概括該類、接口、方法、字段所完成的功能，這句話應(yīng)單獨(dú)占據(jù)一行以突出其概括作用，在這句話后面可以跟隨更加詳細(xì)的描述段落。在描述性段落之后還可以跟隨一些以Javadoc注釋標(biāo)簽開(kāi)頭的特殊段落，例如上面例子中的@auther和@version，這些段落將在生成文檔中以特定方式顯示。

　　雖然為一個(gè)設(shè)計(jì)低劣的程序添加注釋不會(huì)使其變成好的程序，但是如果按照編程規(guī)范編寫(xiě)程序并且為程序添加良好的注釋卻可以幫助你編寫(xiě)出設(shè)計(jì)完美，運(yùn)行效率高且易于理解的程序，尤其是在多人合作完成同一項(xiàng)目時(shí)編程規(guī)范就變得更加重要。俗話說(shuō)“磨刀不誤砍柴工”，花費(fèi)一點(diǎn)時(shí)間去適應(yīng)一下Java編程規(guī)范是有好處的。

本站是提供個(gè)人知識(shí)管理的網(wǎng)絡(luò)存儲(chǔ)空間，所有內(nèi)容均由用戶發(fā)布，不代表本站觀點(diǎn)。請(qǐng)注意甄別內(nèi)容中的聯(lián)系方式、誘導(dǎo)購(gòu)買等信息，謹(jǐn)防詐騙。如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容，請(qǐng)點(diǎn)擊一鍵舉報(bào)。

轉(zhuǎn)藏 分享

QQ空間 QQ好友新浪微博微信

獻(xiàn)花（0） +1

來(lái)自：橙zc > 《java技術(shù)》

舉報(bào)/認(rèn)領(lǐng)