Java工程開發命名規範
阿新 • • 發佈:2018-12-19
1.包:java的包名都是由小寫單片語成的,類名的首字母都是大寫,也就是我們常用的駝峰寫法,包路徑一般都是對系統模板的定義與歸類。這樣看了包名很容易就明白哪一個模組是幹什麼的,很容易通過對應的包路徑找到對應的程式碼!
在java開發的過程中,每名Java開發人員都可以編寫屬於自己的java package,為了在編寫中保證每一個java package命名的唯一性,要求開發人員在自己定義的包名前加上唯一的字首。所以多數開發人員採用自己公司的名稱.專案名.模組名...在網際網路上的域名稱作為自己程式包的唯一字首。例如: com.sun.xml...
但要是個人的專案我們又應該怎麼命名呢? “個人的”單詞搜尋,有“individual、personal、private、one-man”,進一步對以上4個單詞詞意的分析,並在保證了唯一性,使用每個單詞的前4個字母作為字首,正好和“com”也做了區分。如下:
indi : 個體專案,指個人發起,但非自己獨自完成的專案,可公開或私有專案,版權主要屬於發起者。 包名為indi.發起者名.專案名.模組名*.*.* pers : 個人專案,指個人發起,獨自完成,可分享的專案,版權主要屬於個人。 包名為pers.個人名.專案名.模組名*.*.* priv : 私有專案,指個人發起,獨自完成,非公開的私人使用的專案,版權屬於個人。 包名為priv.個人名.專案名.模組名*.*.* 另外,我為了區分團隊專案和前面所說專案的區分,還有了一下擴充套件: team : 團隊專案指由團隊發起,並由該團隊開發的專案,版權屬於該團隊所有。 包名為team.團隊名.專案名.模組名*.*.* com : 公司專案:由專案發起的公司所有。 包名為com.公司名.專案名.模組名*.*.*
2:類:首字母大寫,如果一個類由多個單詞構成,那麼每個單詞的首字母都大寫,而且中間不使用任何的連線符。儘量使用英文。如ConnectionFactory
3:方法:首單詞全部小寫,如果一個方法由多個單詞構成,那麼從第二個單詞開始首字母大寫,不使用連線符。addPerson
4:屬性:與方法相同。如ageOfPerson
5:常量:所有單詞的字母都是大寫,如果有多個單詞,那麼使用下劃線連結即可。