介紹
Google Java Style文檔是Google Java編程規範的完整定義。 依照此規範編寫的Java源碼文件可以被稱爲Google Style。和其他編程規範指南一樣,規範不僅包括了代碼的結構美學,也包括了其他一些業界約定俗成的公約和普遍採用的標準。此文檔中的規範基本都是業界已經達成共識的標準,而且儘量避免去定義那些還存在爭議的地方。
文檔說明
該規範主要分爲6大部分:
- 源文件基本規範:源文件基本規範說明文件名、文件編碼、空格和特殊字符等規範要求。
- 源文件結構:源文件結構說明許可信息、package和import聲明、類成員順序等規範要求。
- 代碼格式:代碼格式用於說明源代碼中大括號、縮進、換行、空格、括號、枚舉、數組、switch語句、註解、註釋和修飾符等格式要求。
- 命名:命名說明了標識符(包、類、方法、常量、屬性、局部變量和類變量)的命名規範和駝峯大小寫定義。
- 編程實踐:編程實踐說明@Override、異常、靜態成員和終結器的用法。
- Javadoc:Javadoc說明哪些地方需要Javadoc,以及它的格式要求。
規範摘要
- import中不能有通配符。
- 重載方法應該放在一起連續出現。
- 2空格縮進
- 列寬是80或100個字符。
- 不能使用類似C語言的數組變量聲明。
- switch語句中,必須包含default語句
- 修飾符的順序應按照Java語言規範推薦的順序。
- 常量命名應使用CONSTANT_CASE格式
Google還提供了其它語言的代碼風格指南,包括C++、Objective-C、Python、Shell、HTML/CSS、JavaScript和Lisp等。
官方網站:http://google-styleguide.googlecode.com/svn/trunk/javaguide.htm