java 程式編寫規則（自己總結）

標籤：排版   沒有   case   將不   大小   底線   傳回值   含義   ftp   

1.命名規範 
（1）所有的標示符都只能用ASCⅡ字母（A-Z或a-z）、數字（0-9）和底線“_”。 
（2）類名是一個名詞，採用大小寫混合的方式，每個單詞的首字母大寫。例如：UserInfo 
（3）介面的大小寫規則與類名相似：例如：UserInterface。 
（4）方法名是一個動詞或動詞片語，採用大小寫混合的方式，第一個單詞的首字母小寫，其後單詞的首字母大寫。例如：setName(String name)。 
（5）變數名採取駝峰式命名，第一個字母小寫，任何中間單詞的首字母大寫。變數名應簡短且可以顧名思義，易於記憶。類的成員變數(自動產生的Mapper類除外,都用小寫m開頭)。 
（6）常量的聲明應該全部大寫，每個單詞之間用“_”串連。例如：final String FTP = "FTP://192.168.1.2"; 
2.注釋規範 
（1）注釋儘可能使用“//”；對於所有的javadoc的注釋則使用“/*”； 
（2）所有的源檔案都在開頭有一個注釋，列出作者和時間，用Myeclipse的模板即可。 
（3）每個方法必須添加註釋（類的main()方法除外）。 
（4）每個屬性必須添加註釋。 
（5）代碼中至少包含15%的注釋。Js代碼應該超過30%的注釋。 
（6）注釋使用中文。 
3.縮排排版規範 
（1）避免一行的長度超過60個字元。 
（2）使用Eclipse的原始碼的格式化功能完成代碼的縮排排版。 
4.檔案名稱規範 
（1）一個Java源檔案只能儲存一個Java類。 
（2）檔案名稱與Java類名相同。 
（3）一個類檔案的程式碼不超過200行。 
5.聲明規範 
（1）一行聲明一個變數。 
（2）不要將不同類型變數的聲明放在同一行。 
（3）只在代碼塊的開始處聲明變數。 
（4）所有的變數必須在聲明時初始化。 
（5）避免聲明的局部變數覆蓋上一級聲明的變數。 
（6）方法與方法之間以空行分隔。 
6.語句規範 
（1）每行至少包含一條簡單語句。 
（2）在return語句中，傳回值不使用小括弧“()”括起來。 
（3）if語句總是用“{”和“}”括起來。每個“{“或者”}“ 都單獨佔用一行。 
（4）在for語句的初始化或更新子句中，避免因使用三個以上變數，而導致複雜度提高。 
（5）當switch的一個case順著往下執行時（因為沒有break語句），通常應在break語句的位置添加註釋。 
7.編程規範 
（1）提供對執行個體以及類變數的public或private存取控制，儘可能不適用預設值或protected存取控制。 
（2）避免用一個對象訪問一個類的靜態變數或方法。應該用類名代替。 
（3）避免在一個語句中給多個變數賦相同的值。 
（4）用switch()語句實現多路分支。 
（5）如果使用JDBC，則考慮使用java.sql.PreparedStatement，而不是java.sql.Statement。 
（6）用於設定對象狀態的方法首碼必須是set；用於檢索一個布爾類型對象狀態的方法首碼必須是is，而用於檢索其他方法首碼必須是get。 
（7）程式中應儘可能少使用數字（或字元），儘可能定義靜態變數來說明該數字（或字元）的含義。程式中需要賦值或比較時，使用前面定義的靜態變數。在迴圈控制中例外。

java 程式編寫規則（自己總結）