介绍
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