Java開發中所要遵守的編碼規范大體上有如下7點。命名規范、注釋規范、縮進排版規范、文件名規范、聲明規范、語句規范以及編程規范。
1.命名規范
(1)所有的標示符都只能用ASCⅡ字母(A-Z或a-z)、數字(0-9)和下劃線“_”。
(2)一個唯一包名的前綴總是全部小寫的字母。例如:www.tonysun.cc
(3)類名是一個名詞,采用大小寫混合的方式,每個單詞的首字母大寫。例如:Tony。
(4)接口的大小寫規則與類名相似:例如:Tony。
(5)方法名是一個動詞或動詞詞組,采用大小寫混合的方式,第一個單詞的首字母小寫,其後單詞的首字母大寫。例如:setNeekeName(String neekeName)。
(6)變量名第一個字母小寫,任何中間單詞的首字母大寫。變量名應簡短且可以顧名思義,易於記憶。例如:neekeName、neekeAddress。避免單個字符的變量名,除非是一次性的臨時變量。
(7)常量的聲明應該全部大寫,每個單詞之間用“_”連接。例如:final String WWW_TONY_CN = "www.tonysun.cc";
2.注釋規范
(1)注釋盡可能使用“//”;對於所有的Javadoc的注釋則使用“/** */”;而臨時對代碼塊進行注釋盡量使用“/* */”。
(2)所有的源文件都應該在開頭有一個注釋,其中列出文件名、日期和類的功能概述。
(3)每個方法必須添加文檔注釋(類的main()方法除外)。
(4)每個屬性必須添加注釋。
(5)代碼中至少包含15%的注釋。
(6)注釋使用中文。
3.縮進排版規范
(1)避免一行的長度超過60個字符。
(2)使用Eclipse的源代碼的格式化功能完成代碼的縮進排版(Ctrl+Shift+F)。
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)程序中應盡可能少使用數字(或字符),盡可能定義靜態變量來說明該數字(或字符)的含義。程序中需要賦值或比較時,使用前面定義的靜態變量。在循環控制中例外。