Google的Java編碼規範

infoq發表於2014-02-13

  Google最近釋出了一份完整的Java編碼規範。規範的內容包括一些切實可行的硬性規定。Google內部均遵守此規範。該規範不僅涵蓋了程式碼格式,還包括其他型別的約定和編碼標準。

  該規範主要分為6大部分:原始檔基本規範、原始檔結構、程式碼格式、命名、程式設計實踐和Javadoc。原始檔基本規範說明檔名、檔案編碼、空格和特殊字元等規範要求。原始檔結構說明許可資訊、package和import宣告、類成員順序等規範要求。程式碼格式用於說明原始碼中大括號、縮排、換行、空格、括號、列舉、陣列、switch語句、註解、註釋和修飾符等格式要求。命名說明了識別符號(包、類、方法、常量、屬性、區域性變數和類變數)的命名規範和駝峰大小寫定義。程式設計實踐說明@Override、異常、靜態成員和終結器的用法。Javadoc說明哪些地方需要Javadoc,以及它的格式要求。

  以下是從規範中摘錄的一些內容:

  • import中不能有萬用字元。
  • 過載方法應該放在一起連續出現。
  • 即使程式碼塊中沒有內容,或者只有一行程式碼,也必須使用大括號。
  • 2空格縮排。
  • 列寬是80或100個字元。
  • 不能使用類似C語言的陣列變數宣告。
  • switch語句中,必須包含default語句。
  • 修飾符的順序應按照Java語言規範推薦的順序。
  • 常量命名應使用CONSTANT_CASE格式(譯註:所有字母大寫,單詞使用下劃線分隔)。注意,所有常量都必須是static final成員,但並不是所有的static final成員都是常量。

  更多內容請閱讀Google Java Style。Oracle也提供了官方的Java語言編碼規範。Google還提供了其它語言的程式碼風格指南,包括C++、Objective-C、Python、Shell、HTML/CSS、JavaScript和Lisp等等。

  原文英文連結:Google's Java Coding Standards

相關文章