java 程序編寫規則(自己總結)
阿新 • • 發佈:2017-09-15
pub switch 成員 文件的 類型 ont 記憶 縮進 setname
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)程序中應盡可能少使用數字(或字符),盡可能定義靜態變量來說明該數字(或字符)的含義。程序中需要賦值或比較時,使用前面定義的靜態變量。在循環控制中例外。
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 程序編寫規則(自己總結)