定義這個規範的目的是讓專案中所有的文件看起來像一個人寫的,增加可讀性,減少專案組中因為換人而帶來的損失。以下跟大家分享java開發命名規範,一起看看吧
最好使用英文,不要用漢語拼音
1:套件( package):用於將完成不同功能的類別分門別類,放在不同的目錄(包)下,包的命名規則:將公司域名反轉作為包名。例如www.bjpowernode.com 對於包名:每個字母都需要小寫。例如:com. bjpowernode.test;該套件下的Test類別的全名是:com. bjpowernode.Test.java 。如果定義類別的時候沒有使用package,那麼java就認為我們定義的類別位於預設套件裡面(default package)。
2:類別:首字母大寫,如果一個類別由多個單字構成,那麼每個單字的首字母都大寫,而且中間不使用任何的連接符號。盡量使用英文。如ConnectionFactory
3:方法:首字全部小寫,如果一個方法由多個單字構成,那麼從第二個字開始首字母大寫,不使用連接符。 addPerson
4:屬性:與方法相同。如ageOfPerson
5:常數:所有單字的字母都是大寫,如果有多個單詞,那麼使用下劃線連結即可。
如:
public static final int AGE_OF_PERSON = 20; //通常加上static
補充:在變數命名時要注意以下幾點:
· 選擇有意義的名字,注意每個單字首字母要大寫。
· 在一段函數中不使用同一個變數表示前後意義不同的兩個數值。
· i、j、k等只作為小型迴圈的循環索引變數。
· 避免用Flag來命名狀態變數。
· 用Is來命名邏輯變量,如:blnFileIsFound。透過這種給布林變數肯定形式的命名方式,使得其它開發人員能夠更為清楚的理解布林變數所代表的意義。
· 如果需要的話,在變數最後附加計算限定詞,如:curSalesSum。
· 命名不相包含,curSales和curSalesSum。
· static final 變數(常數)的名字應該都大寫,並且指出完整意義。
· 如果需要對變數名稱進行縮寫時,請務必注意整個程式碼中縮寫規則的一致性。例如,如果在程式碼的某些區域中使用intCnt,而在其他區域中又使用intCount,就會為程式碼增加不必要的複雜度。建議變數名中盡量不要出現縮寫。
· 透過在結尾處放置一個量詞,就可創建更統一的變量,它們更容易理解,也更容易搜尋。例如,請使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常用的量詞字尾有:First(一組變數中的第一個)、Last(一組變數中的最後一個)、Next(一組變數中的下一個變數)、 Prev(一組變數中的上一個)、Cur(一組變數中的目前變數)。
· 為每個變數選擇最佳的資料型態,這樣即能減少對記憶體的需求量,加快程式碼的執行速度,又會降低出錯的可能性。用於變數的資料類型可能會影響該變數進行計算所產生的結果。在這種情況下,編譯器不會產生運行期錯誤,它只是迫使該值符合資料類型的要求。這類問題極難查找。
· 盡量縮小變數的作用域。如果變數的作用域大於它應有的範圍,變數可繼續存在,並且在不再需要該變數後的很長時間內仍佔用資源。它們的主要問題是,任何類別 中的任何方法都能對它們進行修改,並且很難追蹤究竟是何處進行修改的。佔用資源是作用域涉及的重要問題。對變數來說,盡量縮小作用域將對應用程式的 可靠性產生巨大的影響。
關於常數的命名方法,在JAVA程式碼中,無論何時,均提倡應用常數取代數字、固定字串。也就是 說,程序中除0,1以外,盡量不應該出現其他數字。常數可以集中在程式開始部分定義或更寬的作用域內,名字應該都使用大寫字母,並且指出該常數完整含 義。如果一個常數名稱由多個單字組成,則應該用底線「_」來分割這些單字如:NUM_DAYS_IN_WEEK、MAX_VALUE。
以上是Java專案開發命名規格(動力節點整理)的詳細內容。更多資訊請關注PHP中文網其他相關文章!