没有合适的资源?快使用搜索试试~ 我知道了~
首页Google Java编程风格规范的完整定义.pdf
资源详情
资源评论
资源推荐
前言
这份文档是 Google Java 编程风格规范的完整定义。当且仅当一个 Java 源文件
符合此文档中的规则, 我们才认为它符合 Google 的 Java 编程风格。
与其它的编程风格指南一样,这里所讨论的不仅仅是编码格式美不美观的问
题, 同时也讨论一些约定及编码标准。然而,这份文档主要侧重于我们所普遍
遵循的规则, 对于那些不是明确强制要求的,我们尽量避免提供意见。
1.1 术语说明
在本文档中,除非另有说明:
1. 术语 class 可表示一个普通类,枚举类,接口或是 annotation 类型
(@interface)
2. 术语 comment 只用来指代实现的注释(implementation comments),我们
不使用“documentation comments”一词,而是用 Javadoc。
其他的术语说明会偶尔在后面的文档出现。
1.2 指南说明
本文档中的示例代码并不作为规范。也就是说,虽然示例代码是遵循 Google 编
程风格,但并不意味着这是展现这些代码的唯一方式。 示例中的格式选择不应
该被强制定为规则。
源文件基础
2.1 文件名
源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。
2.2 文件编码:UTF-8
源文件编码格式为 UTF-8。
2.3 特殊字符
2.3.1 空白字符
除了行结束符序列,ASCII 水平空格字符(0×20,即空格)是源文件中唯一允许
出现的空白字符,这意味着:
1. 所有其它字符串中的空白字符都要进行转义。
2. 制表符不用于缩进。
2.3.2 特殊转义序列
对于具有特殊转义序列的任何字符(\b, \t, \n, \f, \r, \“, \‘及$$,我们
使用它的转义序列,而不是相应的八进制(比如 12)或 Unicode(比如\u000a)转
义。
2.3.3 非 ASCII 字符
对于剩余的非 ASCII 字符,是使用实际的 Unicode 字符(比如∞),还是使用等
价的 Unicode 转义符(比如\u221e),取决于哪个能让代码更易于阅读和理解。
Tip: 在使用 Unicode 转义符或是一些实际的 Unicode 字符时,建议做些注释给
出解释,这有助于别人阅读和理解。
例如:
String unitAbbrev = "μs"; | 赞,即使
没有注释也非常清晰
String unitAbbrev = "\u03bcs"; // "μs" | 允许,但
没有理由要这样做
String unitAbbrev = "\u03bcs"; // Greek letter mu, "s" | 允许,但
这样做显得笨拙还容易出错
String unitAbbrev = "\u03bcs"; | 很糟,读
者根本看不出这是什么
return '\ufeff' + content; // byte order mark | Good,对
于非打印字符,使用转义,并在必要时写上注释
Tip: 永远不要由于害怕某些程序可能无法正确处理非 ASCII 字符而让你的代码
可读性变差。当程序无法正确处理非 ASCII 字符时,它自然无法正确运行, 你
就会去 fix 这些问题的了。(言下之意就是大胆去用非 ASCII 字符,如果真的有
需要的话)
源文件结构
一个源文件包含(按顺序地):
1. 许可证或版权信息(如有需要)
2. package 语句
3. import 语句
4. 一个顶级类(只有一个)
以上每个部分之间用一个空行隔开。
3.1 许可证或版权信息
如果一个文件包含许可证或版权信息,那么它应当被放在文件最前面。
3.2 package 语句
package 语句不换行,列限制(4.4 节)并不适用于 package 语句。(即 package
语句写在一行里)
3.3 import 语句
3.3.1 import 不要使用通配符
即,不要出现类似这样的 import 语句:import java.util.*;
3.3.2 不要换行
import 语句不换行,列限制(4.4 节)并不适用于 import 语句。(每个 import 语
句独立成行)
3.3.3 顺序和间距
import 语句可分为以下几组,按照这个顺序,每组由一个空行分隔:
1. 所有的静态导入独立成组
2. com.google imports(仅当这个源文件是在 com.google 包下)
3. 第三方的包。每个顶级包为一组,字典序。例如:android, com,
junit, org, sun
4. java imports
5. javax imports
组内不空行,按字典序排列。
3.4 类声明
3.4.1 只有一个顶级类声明
每个顶级类都在一个与它同名的源文件中(当然,还包含.java 后缀)。
例外:package-info.java,该文件中可没有 package-info 类。
3.4.2 类成员顺序
类的成员顺序对易学性有很大的影响,但这也不存在唯一的通用法则。不同的
类对成员的排序可能是不同的。 最重要的一点,每个类应该以某种逻辑去排序
它的成员,维护者应该要能解释这种排序逻辑。比如, 新的方法不能总是习惯
性地添加到类的结尾,因为这样就是按时间顺序而非某种逻辑来排序的。
3.4.2.1 重载:永不分离
当一个类有多个构造函数,或是多个同名方法,这些函数/方法应该按顺序出现
在一起,中间不要放进其它函数/方法。
格式
术语说明:块状结构(block-like construct)指的是一个类,方法或构造函数
的主体。需要注意的是,数组初始化中的初始值可被选择性地视为块状结构
(4.8.3.1 节)。
4.1 大括号
4.1.1 使用大括号(即使是可选的)
大括号与 if, else, for, do, while 语句一起使用,即使只有一条语句(或是
空),也应该把大括号写上。
4.1.2 非空块:K & R 风格
剩余16页未读,继续阅读
Alvin_lin
- 粉丝: 0
- 资源: 7
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- zigbee-cluster-library-specification
- JSBSim Reference Manual
- c++校园超市商品信息管理系统课程设计说明书(含源代码) (2).pdf
- 建筑供配电系统相关课件.pptx
- 企业管理规章制度及管理模式.doc
- vb打开摄像头.doc
- 云计算-可信计算中认证协议改进方案.pdf
- [详细完整版]单片机编程4.ppt
- c语言常用算法.pdf
- c++经典程序代码大全.pdf
- 单片机数字时钟资料.doc
- 11项目管理前沿1.0.pptx
- 基于ssm的“魅力”繁峙宣传网站的设计与实现论文.doc
- 智慧交通综合解决方案.pptx
- 建筑防潮设计-PowerPointPresentati.pptx
- SPC统计过程控制程序.pptx
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0