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