1. 程式人生 > >Java架構-Java程式碼規範那些事

Java架構-Java程式碼規範那些事

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)程式中應儘可能少使用數字(或字元),儘可能定義靜態變數來說明該數字(或字元)的含義。程式中需要賦值或比較時,使用前面定義的靜態變數。在迴圈控制中例外。


為什麼某些人會一直比你優秀,是因為他本身就很優秀還一直在持續努力變得更優秀,而你是不是還在滿足於現狀內心在竊喜!

合理利用自己每一分每一秒的時間來學習提升自己,不要再用"沒有時間“來掩飾自己思想上的懶惰!趁年輕,使勁拼,給未來的自己一個交代!

我本人邀約各大BATJ架構大牛共創Java架構師社群群,(群號:673043639)致力於免費提供Java架構行業交流平臺,通過這個平臺讓大家相互學習成長,提高技術,讓自己的水平進階一個檔次,成功通往Java架構技術大牛或架構師發展

希望此文能幫到大家的同時,也聽聽大家的觀點。歡迎留言討論,加關注,分享你的高見!持續更新

  • To-陌霖Java架構

分享網際網路最新文章 關注網際網路最新發展