1.檔案
1.屬性檔案後綴為properties,且符合java中i18n的規格;
2.對於各產品模組自己的設定檔必須放置在自己模組的conf目錄下;
3.檔案的命名有一定的意義,盡量簡短,名稱符合作業系統的要求且必須為英文或漢語拼音組成,檔案名稱不能存在空格,對於普通的檔案單字與單字之間採用下滑線進行。
2.命名規範
2.1基本規則
1.字符集在26個英文字母、0到9的阿拉伯數字和下劃線之中。 Java中類別、字段、方法、變數、常數盡量用字母表達,沒有特別的理由不能用任何的其他字符
2.命名需要有一定的意義,推薦採用問題域中的術語命名,使命名在一定程度上是自描述的
3.命名盡量的短,如果命名太長,可以採用別名的方式,或者縮寫來簡化命名。縮寫一定要有的意義,而且需要在整個專案中維護這些縮寫的意義
4.名稱縮寫的規則(對於類別名稱、欄位名稱、變數名稱、模組名稱等適用)
1)刪除所有的原音字母,壓縮重複字母。如button,縮寫為btn,
2)如發生命名衝突,則在某一縮寫中保留原音。如batton,為了不與button衝突,縮寫為batn
5.不要用前導底線,也不要在命名的末尾用下劃線
2.2常數命名規則
1.所有的字符都必須大寫。採用有意義的單字組合表達,單字與單字之間以「_」底線隔開。
2.命名盡量簡短,不要超過16個字元
程式開發中最好不要直接對literal進行工作,最好引入常量方式應用;只有在特別的情況下才能使用, 如在for循環中初始化變數時可直接用-1,0,1這些常數
例
publicfinalintMAX_SIZE =120; publicfinalintMAX_WIDTH =100; publicfinalString PROPERTY_NAME="menu";
2.3變量命名規則
1.避免在命名中採用數字,除非命名意義明確,程序更加清晰,對實例變量的命名中不應該有數字
2.變數名稱是名詞意義
3.採用符合問題域意義的單字或單字組合。第一個字除外,如URL)
4.命名盡量簡短,不要超過16個字元
5.除了生命週期很短的臨時變量外,避免採用單字元作為變數名,實例變數的命名不要用單字元。常用的單字元變數如整數用 i、j、 k、 m、 n字符型用c、d、 e,座標用x、y、z。
6.在某些情況下,變數可能需要加上類型前綴,所有的類型前綴必須是小寫,他與變數名稱的實體部分沒有任何間隔,實體部的每個單字都是首字母大寫,其餘字母小寫(特殊字除外如URL),類別的全域變數強烈建議使用,一般的型別字首如下
publicintwidth; publicString fileName; publicstaticApplicationContext context;
2.4方法命名規則
1.使用符合問題域意義的單字組合。第一個單字採用小寫,後續的每個單字採用首字母大寫,其餘小寫(特殊字除外如URL),沒有特別理由不用下劃線作為分隔符號
2.在Java中對屬性方法命名遵循JavaBean的標準:
1) getter方法:get+屬性名, 對boolean型採用is+屬性名,有些特定的屬性名用has, can代替is可能更好
2) setter 方法: set+屬性名
名一致
2.5類別和介面命名規則
1.採用符合問題域意義的單字或單字組合,每個單字的首字母大寫,其餘字母小寫(特殊字除外如URL)
2.介面的第一個字符採用I
例
publicclassFiugre publicinterfaceFiugreContainer publicclassStdFigure//std为Standard的缩写
2.6包的命名規則
1.包名所有的字符都為小寫;
2.兩個不同業務的包之間不要雙向依賴,可以單向依賴;
2.兩個不同業務的包之間不要雙向依賴,可以單向依賴;