規范需要平時編碼過程中注意,是一個慢慢養成的好習慣
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這些常量
例
public final int MAX_SIZE = 120;public final int MAX_WIDTH = 100;public final String 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),類的全局變量強烈建議使用,一般的類型前綴如下
類型前綴 | 類型 | 例子 |
b | Boolean、boolean | bsingle |
f | 浮點數 | fsize |
d | UFDouble | dmoney |
dt | Date | dtToday |
c | Character,、char | cinput |
obj | OBJECT變量 | objUser |
str | 字符串(String, StringBuffer) | strFileName |
i | 整型數 | iCount |
ary | 數組 | aryName |
conn | 連接 | connActiveConnection |
stmt | Statement | stmtFindUser |
rs | Resultset | rsUsers |
ArrayList | al | alData |
Map | map | key_value_Map |
Set | set | valueSet |
col | Collection | colNames |
msg | 消息 | msgText |
err | 錯誤 | errCode |
btn | 按鈕 | btnSubmit |
例
public int width;public String fileName;public static applicationContext context;
2.4方法命名規則
1.采用有符合問題域意義的單詞或單詞組合。第一個單詞采用小寫,后續的每個單詞采用首字母大寫,其余小寫(特殊字除外如URL),沒有特別理由不用下劃線作為分隔符 2.在Java中對屬性方法命名遵循JavaBean的標準: 1)getter方法:get+屬性名, 對boolean型采用is+屬性名,有些特定的屬性名用has, can代替is可能更好 2)setter方法: set+屬性名 3.構造方法的命名與類名一致
2.5類和接口命名規則
1.采用有符合問題域意義的單詞或單詞組合,每個單詞的首字母大寫,其余字母小寫(特殊字除外如URL) 2.接口的第一個字符采用I
例
public class Fiugrepublic interface FiugreContainerpublic class StdFigure //std為Standard的縮寫
2.6包的命名規則
1.包名所有的字符都為小寫; 2.兩個不同業務的包之間不要雙向依賴,可以單向依賴; 3.采用邏輯上的層次結構,從而減少依賴
|
新聞熱點
疑難解答