Java開發中所要遵守的編碼規格大體上有如下7點。命名規範、註解規範、縮排版規範、檔案名稱規範、聲明規範、語句規範、程式設計規範。 【推薦學習:java影片教學】
#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)程式中應盡可能少使用數字(或字元),盡可能定義靜態變數來說明該數字(或字元)的意義。程式中需要賦值或比較時,使用前面定義的靜態變數。在循環控制中例外。
本文來自 java入門 欄目,歡迎學習!
以上是Java開發之程式碼規格詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章!