JAVA編碼規範

看到國內某公司的編碼規範,總結了一下:
1.順序:變更履歷
Package聲明
Import聲明
Class Header
Class
常量(Menifest Variables)
成員變量(Instance Variables)
初始Block(initializer Blocks)
構造器(Constructors)
屬性(Properties)
方法(Public Method)
方法(Protected Methods)
方法(Private Methods)
內部類(Inner Class)
測試方法(Test Main)

2.標準的package名可以分爲三部分:<公司名>.<應用程序名>.<包名>;全部爲小寫字母

3.“Class Header”可以分爲3部分——說明部分、版本信息和其他信息,中間使用NULL行分割。
 程序中的每一個類都必須有Class註釋。根據需要,Class註釋中除了說明部分不能省略外,版本信息和其他信息都可以省略。
 Class註釋中的說明部分的寫法參考範例,根據需要,可以省略其中的一些說明部分(可省略的部分後標有可選)。

4.Class的名稱應該是一個名詞短語。 可以是“形容詞/名詞 + 名詞”的形式。 例如InputDataStream、Developer、OrderItem等。Class的名稱由1個或1個以上的英語句單詞組成, 其中每一個英語句單詞的首字母應該大寫, 其餘字母小寫。

5.類成員變量的名稱使用26個英文字母並且規定使用下劃線“_”開頭。

6.如果缺省構造器中沒有任何代碼,則應使用“//null”標註
public MyClass() { //正確
//null
}

7.在方法內部的註釋要寫明Why,而不是What

8.當Class名由多個單詞組成時,每個單詞的第1個字母(段落)都要大寫;例外Class名的最後要加上“Exception”;Interface的命名規則基本上要基於Class名。統一此寫法,將提高代碼的易讀性。如果需要與Class名區分,請在開頭加上“I”。

9.關於Method名,只有一個單詞時,全部採用小寫字。當由多個單詞組成時,第2個以後的單詞的第1個字母要大寫;生成Object的Method名的格式是“"create"+Object名”;
轉換Method名的格式是“"to"+Object名”
Getter Method名的格式是“"get"+屬性名”
Setter Method名的格式是“"set"+屬性名”
boolean 通過返回變量的Method名要能看出true/false的狀態

10.變量命名:
通過boolean變量要能看出true/false的狀態;
常量全部爲static final、全部是大寫字、段落用“_”
變量名要反映其作用
Instance變量名的格式是“"_"+變量名”
Instance的字段名全部使用大寫字

11.控制語句規範:
關於for語句的循環計數器,各嵌套分別使用"I"、"j"、"k"…等
控制語句(if, else, while, for, do while)的“{ }”是不可省略的
在利用了for語句的重複處理中,不更改循環變量的值
for語句的計數從0開始
使用break及continue將變得難懂
不要在循環內生成對象

12.命令語句風格規範
return語句不使用括號
boolean變量已比較完畢
不等號要向左("<"、"<=")
不輕易重複使用Local變量
在單一Method中不能使用4次以上否定運算符“!”
表示long型的常量時,使用“L”而不是“I”
不使用嵌套的賦值

13.聲明語句風格規範
1個Statement中有1個變量聲明
數組聲明形式爲“型名[]”
變量聲明要有初始值

14.書寫格式規範
不使用Tab,而且使用空白字符
縮進量是4個空白字符
避免過長的行
在"{"之後不寫Statement
在逗號之後輸入空白字符
在賦值運算符(=, +=, -=, …)前後輸入空白字符
在for語句內的分號之後輸入空白字符
在“++”及“--”和運算數之間不輸入空白字符
在Bit運算符("|"、"&"、"^"、"<<"、">>")的前後輸入空白字符
在邏輯運算符("||"、"&&")的前後輸入空白字符
在關係運算符("<"、">"、">="、"<="、"=="、"!= ")的前後輸入空白字符
在算術運算符("+"、"-"、"*"、"/"、"%")的前後輸入空白字符
在條件運算符“?”的前後分別輸入1個空白字符
最後寫main()
禁止使用System.out.println輸出(爲了控制系統中的日誌輸出,原則上禁止使用System.out.println輸出。調試階段的System.out.println輸出在發佈時應該註釋掉)


確實,規範的編碼容易閱讀,容易進行維護,也很美觀,不過這些多的細節還得在以後的編碼過程中慢慢的養成……
發佈了12 篇原創文章 · 獲贊 0 · 訪問量 2545
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章