當前位置:才華齋>計算機>java語言>

Java命名規範介紹

java語言 閱讀(2.24W)

Java定義這個規範的目的是讓專案中所有的文件都看起來像一個人寫的,增加可讀性,減少專案組中因為換人而帶來的損失。下面是小編為大家搜尋整理的Java命名規範介紹,希望大家能有所收穫,更多精彩內容請及時關注我們應屆畢業生考試網!

Java命名規範介紹

  一、(Package)包的命名

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

例如: group

  二、(Class)類的命名

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

例如: Circle

  三、方法的命名

方法的名字的第一個單詞應以小寫字母作為開頭,後面的單詞則用大寫字母開頭。

例如: sendMessge

  四、引數的命名

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

  五、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,這些段落將在生成文件中以特定方式顯示。

  六、變數命名

變數命名應該採用首字母小寫,其他字母首字母大寫的方式。

· Static Final 變數的名字應該都大寫,並且指出完整含義。

· 如果需要對變數名進行縮寫時,一定要注意整個程式碼中縮寫規則的一致性。例如,如果在程式碼的某些區域中使用intCnt,而在另一些區域中又使用intCount,就會給程式碼增加不必要的複雜性。建議變數名中儘量不要出現縮寫。

· 通過在結尾處放置一個量詞,就可建立更加統一的變數,它們更容易理解,也更容易搜尋。例如,請使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常用的量詞字尾有:First(一組變數中的第一個)、Last(一組變數中的最後一個)、Next(一組變數中的下一個變數)、Prev(一組變數中的上一個)、Cur(一組變數中的當前變數)。

· 為每個變數選擇最佳的'資料型別,這樣即能減少對記憶體的需求量,加快程式碼的執行速度,又會降低出錯的可能性。用於變數的資料型別可能會影響該變數進行計算所產生的結果。在這種情況下,編譯器不會產生執行期錯誤,它只是迫使該值符合資料型別的要求。這類問題極難查詢。

· 儘量縮小變數的作用域。如果變數的作用域大於它應有的範圍,變數可繼續存在,並且在不再需要該變數後的很長時間內仍然佔用資源。它們的主要問題是,任何類中的任何方法都能對它們進行修改,並且很難跟蹤究竟是何處進行修改的。佔用資源是作用域涉及的一個重要問題。對變數來說,儘量縮小作用域將會對應用程式的可靠性產生巨大的影響。

  七、關於常量的命名方法

在JAVA程式碼中,無論什麼時候,均提倡應用常量取代數字、固定字串。也就是說,程式中除0,1以外,儘量不應該出現其他數字。常量可以集中在程式開始部分定義或者更寬的作用域內,名字應該都使用大寫字母,並且指出該常量完整含義。如果一個常量名稱由多個單片語成,則應該用下劃線“_”來分割這些單詞如:NUM_DAYS_IN_WEEK、MAX_VALUE。

  八、推薦的命名

1、類名推薦

當要區別介面和實現類的時候,可以在類的後面加上“Impl”。例如: interface Container ,class ContainerImpl

class Container3PImpl

class ContainerYICTImpl

2、Exception類名推薦

Exception類最好能用“Exception”做為類命名的結尾。