編碼規范很重要,這里就不說為什么重要了。
以下內容會由於個人的情況不同會出現一些調整,這里提供一個參考。
1.文件組織
程序行數不宜過多,注釋和空行分割應合理。
2.源文件
每個JAVA源文件都包含一個單一的公共類或接口,且公共類必須是這里的第一個類。
3.開頭注釋
根據個人需要,最好列出類名,版本信息,日期,等等。
4.包和引入語句
第一個非注釋行是包語句,其后可以跟引入語句。
5.縮進
使用4個空格作為縮進單位,或將TAB鍵的占位符設置為4.
6.排版
避免再一個語句里給多個變量賦值。
參數列表的逗號后面應有一個空格。(包括for語句)
二元運算符除了“.”,應該使用空格符將之與操作數分開。
7.行長度
盡量避免一行的長度超過150字符。
8.換行
每行只能有一個聲明。
兩個方法之間使用空行。
當表達式無法容納在一行內的時候,
可以用{}換行,
在逗號或操作符前面斷開,
新的一行應該與同級的表達式對齊。
9.注釋
注釋不應寫在大框里,注釋里不應包括制表符和回退符等特殊字符。
注釋風格大概有四種:
塊,
單行,
尾端,
行末。
不要在應保持注釋一致性的時候使用復數的注釋風格。
10.javadoc注釋
對類,接口,公用和保護類變量使用javadoc注釋,必須包括描述,參數,返回值,異常的說明。
11.注釋格式
方法的內部采用單行注釋,不要和代碼同一行。
12.類內部的成員變量
單行注釋。
13.聲明
一行一個聲明。
14.初始化
盡量在聲明局部變量的同事初始化。
15.布局
在代碼塊的開始處聲明變量,將局部變量的作用域最小化。
16.類和接口的聲明
方法名與其參數列表之前的左括號間不要有空格。
左大括號位於聲明語句的同行末尾。
方法與方法之間以空行分隔。
17.簡單語句
每行最多包含一條語句。
18.復合語句
左大括號應該位於起始行的末尾,右大括號應另起一行並與復合語句首行對齊。
即使是單行的if-else語句或for語句,也建議加上大括號,這樣可以有效防止因為添加語句后而忘了加大括號的行為。
19.返回語句
一個帶返回值的語句一般不使用小括號,除了以下情況
return;
return myDisk.size();
return (size?size:defaultSize);
20.塊語句
if,else,while,for語句必須有{},空格。
{必須在一行之末,}在一行之頭。
21.命名規范
包路徑必須小寫。
類名應該是名詞,或者是名詞+動詞
接口的第一個字母大寫。
多個單詞合成的一個類名,每個單詞首字母大寫。
數據訪問用表明+DAO+方言方式。
接口首字母為I。
方法用駝峰命名法。
數組用byte[] buffer;而不是byte buffer[];,根絕類名首字母小寫,數組增加Arr后綴。
變量用匈牙利命名。
常量全大寫,使用關鍵字final。中間用下划線分割單詞。
組件命名以相應組件結尾。