GoogleJava编程风格指南.pdf资源-CSDN文库

5星 · 超过95%的资源需积分: 12 190 浏览量 2015-03-04 10:18:12 上传评论 4 收藏 427KB PDF 举报

资源推荐

资源详情

资源评论

Hawstein's Blog
Home
Archive
Categories
Sitemap
About
Subscribe
Google Java编程风格指南
January 20, 2014
作者：Hawstein
出处：http://hawstein.com/posts/google-java-style.html
声明：本文采用以下协议进行授权： 自由转载-非商用-非衍生-保持署名|Creative Commons BY-NC-ND 3.0
，转载请注明作者及出处。
目录
1.  前言
2.  源文件基础
3.  源文件结构
4.  格式
5.  命名约定
6.  编程实践
7.  Javadoc
8.  后记
前言
这份文档是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水平空格字符(0x20，即空格)是源文件中唯一允许出现的空白字符，这意味着：

1. 所有其它字符串中的空白字符都要进行转义。

2. 制表符不用于缩进。

2.3.2 特殊转义序列

对于具有特殊转义序列的任何字符(\b, \t, \n, \f, \r, \“, \‘及\)，我们使用它的转义序列，而不是相

应的八进制(比如\012)或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 风格

对于非空块和块状结构，大括号遵循Kernighan和Ritchie风格 (Egyptian brackets):

左大括号前不换行

左大括号后换行

右大括号前换行

剩余11页未读，继续阅读

评论收藏

内容反馈

Chuck2014

2018-03-21

很好，很强大，感谢分享
理想AWP

2015-06-25

正在进行代码规范设计，很有用的参考资料
黑板擦pp

2015-10-20

翻译的很好，要采用这个标准开发了
幻星璇

2015-11-06

很好~~很有用~~~
duti126

2015-12-09

不错，很有帮助，看来要按着编程规范好好改进下了~~

jh__mail

粉丝: 0
资源: 6

Google Java编程风格指南.pdf

最新资源

Google Java编程风格指南.pdf

Google Java编程风格指南

Java编程风格

Google-Java编程风格指南中文版 高清完整PDF版

Google Java编程风格指南中文版

Google Java编程风格规范的完整定义

google_c++编程风格指南.pdf

Google C++编程风格指南.pdf

Google C++编程风格指南 .rar

2019/2020 Google C++编程风格指南.pdf

Good Java编程风格指南.docx

Google+C++编程风格指南.pdf

Google_C++编程风格指南.pdf

Google 开源项目风格指南.pdf

电子-谷歌C编程指南.pdf

Google Java编程风格规范.docx

Google 开源项目风格指南.pdf（C++，2017版）

Google_C++_Style_Guide_谷歌_C++编码风格指南.docx

Google C++编程风格指南.zip

谷歌C++编程指南.pdf

Java第十五届蓝桥杯大赛软件JavaB组真题

SwitchHosts

安卓期末大作业（AndroidStudio开发），垃圾分类助手app，分为前台后台，代码有注释，均能正常运行

Notepad++安装包

2024北森能力测评题库.7z

微信小程序源码-合集1.rar

Java面试八股文2023最新版

Linux Centos7 升级最新版OpenSSH-9.6p1 有脚本（支持离线）

JDK1.8 windows 64位

最新资源

Google-Java编程风格指南中文版高清完整PDF版