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