《Google的Java編碼規(guī)范》(Google Java Style)在線地址

2014-02-17 15:04:48來源:InfoQ作者:

Google最近發(fā)布了一份完整的Java編碼規(guī)范。規(guī)范的內(nèi)容包括一些切實(shí)可行的硬性規(guī)定。Google內(nèi)部均遵守此規(guī)范。該規(guī)范不僅涵蓋了代碼格式,還包括其他類型的約定和編碼標(biāo)準(zhǔn)。

Google最近發(fā)布了一份完整的Java編碼規(guī)范。規(guī)范的內(nèi)容包括一些切實(shí)可行的硬性規(guī)定。Google內(nèi)部均遵守此規(guī)范。該規(guī)范不僅涵蓋了代碼格式,還包括其他類型的約定和編碼標(biāo)準(zhǔn)。

該規(guī)范主要分為6大部分:源文件基本規(guī)范、源文件結(jié)構(gòu)、代碼格式、命名、編程實(shí)踐和Javadoc。源文件基本規(guī)范說明文件名、文件編碼、空格和特殊字符等規(guī)范要求。源文件結(jié)構(gòu)說明許可信息、package和import聲明、類成員順序等規(guī)范要求。代碼格式用于說明源代碼中大括號、縮進(jìn)、換行、空格、括號、枚舉、數(shù)組、switch語句、注解、注釋和修飾符等格式要求。命名說明了標(biāo)識符(包、類、方法、常量、屬性、局部變量和類變量)的命名規(guī)范和駝峰大小寫定義。編程實(shí)踐說明@Override、異常、靜態(tài)成員和終結(jié)器的用法。Javadoc說明哪些地方需要Javadoc,以及它的格式要求。

以下是從規(guī)范中摘錄的一些內(nèi)容:

  • import中不能有通配符。
  • 重載方法應(yīng)該放在一起連續(xù)出現(xiàn)。
  • 即使代碼塊中沒有內(nèi)容,或者只有一行代碼,也必須使用大括號。
  • 2空格縮進(jìn)。
  • 列寬是80或100個字符。
  • 不能使用類似C語言的數(shù)組變量聲明。
  • switch語句中,必須包含default語句。
  • 修飾符的順序應(yīng)按照J(rèn)ava語言規(guī)范推薦的順序。
  • 常量命名應(yīng)使用CONSTANT_CASE格式(譯注:所有字母大寫,單詞使用下劃線分隔)。注意,所有常量都必須是static final成員,但并不是所有的static final成員都是常量。

《Google的Java編碼規(guī)范》在線地址:http://google-styleguide.googlecode.com/svn/trunk/javaguide.html

《Oracle的Java編碼規(guī)范》在線地址:http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html

關(guān)鍵詞:GoogleJava編碼規(guī)范

贊助商鏈接: