第一原則: 見名知意,類名最好用名字,方法名用動詞。
在面向對象編程中,對於類、對象變量、方法等的命名是非常有技巧的,例如,大小寫的區分,使用不同字母開頭等。但究其本,在爲一個資源命名時,應該本着描述性和惟一性兩大特徵,才能保證資源之間不衝突,並且便於理解記憶。
1.包的命名
Java包的名字都是由小寫單詞組成。一般採用域名的反寫。
例如:com.foundersoftware.enotebook.demo。
2.類的命名
類的名字必須由大寫字母開頭,一個單詞中的其他字母均爲小寫。如果類名稱由多個單詞組成,則建議將每個單詞的首字母均用大寫,例如TestPage。如果類名稱中包含單詞縮寫,則建議將這個詞的每個字母均用大寫,如:XMLExample。由於類是設計用來代表對象的,所以建議在命名類時應儘量選擇名詞。
3.方法的命名
方法的名字的第1個單詞應以小寫字母開頭,後面的單詞首字母要大寫,建議在方法命名時儘量選擇動詞。
例如:sendMessge()。
4.常量的命名
常量的名字應該都使用大寫字母,並且指出該常量完整含義。如果一個常量名稱由多個單詞組成,則建議用下劃線來分割這些單詞。
例如:MAX_VALUE。
5.參數的命名
參數的命名規範和方法的命名規範相同,而且爲了避免閱讀程序時造成迷惑,請在儘量保證在參數名稱爲一個單詞的情況下,參數的命名儘可能明確。
6.Javadoc註釋
Java除了可以採用常見的註釋方式之外,Java語言規範還定義了一種特殊的註釋,也就是通常所說的Javadoc註釋,它是用來記錄代碼中的API的。Javadoc註釋是一種多行註釋,以/**開頭,而以*/結束,註釋可以包含一些HTML標記符和專門的關鍵詞。使用Javadoc註釋的好處是編寫的註釋可以被自動轉化爲在線文檔,省去了單獨編寫程序文檔的麻煩。例如:
/**
*
*@author
*/
在每個程序的最開始部分,一般都用Javadoc註釋進行程序的總體描述以及版權信息。在主程序中可以爲每個類、接口、方法、變量添加Javadoc註釋,每個註釋的開頭部分先用一句話概括該類、接口、方法、變量所完成的功能,這句話應單獨佔據一行以突出其概括作用,在這句話後面可以跟隨更加詳細的描述段落。
在描述性段落之後還可以跟隨一些以Javadoc註釋標籤開頭的特殊段落,例如上面例子中的@auther和@version,這些段落將在生成的文檔中以特定方式顯示。
7.工程名
工程名一般全用小寫字母,每個單詞之間加下劃線或中劃線,如‘ssh_training_itemmgr’
類、方法、接口之間最好空一行,多參考sun代碼規範。
總結:
1.雖然添加註釋不會使一個設計低劣的程序變成好的程序,但是如果按照編程規範編寫程序,並且爲程序添加良好的註釋,卻可以幫助編寫出設計優美、運行高效且易於理解的程序,尤其在多人合作完成同一項目時,編程規範非常重要。俗話說"磨刀不誤砍柴工",花費一點時間去適應一下Java編程規範是有好處的。
2.如果註釋不規範,在自動管理項目時還會出現錯誤。例如在mvn site 時經常會出現javadoc錯誤提示。