Google编程标准规范专业资料.docVIP

GoogleJava编程风格指南

January20，

作者：Hawstein

出处：

声明：本文采用如下合同进行授权：自由转载-非商用-非衍生-保持签名|CreativeCommonsBY-NC-ND3.0，转载请注明作者及出处。

目录

前言

源文献基本

源文献构造

格式

命名商定

编程实践

Javadoc

后记

前言

这份文档是GoogleJava编程风格规范完整定义。当且仅当一种Java源文献符合此文档中规则，咱们才以为它符合GoogleJava编程风格。

与其他编程风格指南同样，这里所讨论不但仅是编码格式美不美观问题，同步也讨论某些商定及编码原则。然而，这份文档重要侧重于咱们所普遍遵循规则，对于那些不是明确强制规定，咱们尽量避免提供意见。

1.1术语阐明

在本文档中，除非另有阐明：

术语class可表达一种普通类，枚举类，接口或是annotation类型(@interface)

术语comment只用来指代实现注释(implementationcomments)，咱们不使用“documentationcomments”一词，而是用Javadoc。

其她术语阐明会偶尔在背面文档浮现。

1.2指南阐明

本文档中示例代码并不作为规范。也就是说，虽然示例代码是遵循Google编程风格，但并不意味着这是呈现这些代码唯一方式。示例中格式选取不应当被强制定为规则。

源文献基本

2.1文献名

源文献以其最顶层类名来命名，大小写敏感，文献扩展名为.java。

2.2文献编码：UTF-8

源文献编码格式为UTF-8。

2.3特殊字符

2.3.1空白字符

除了行结束符序列，ASCII水平空格字符(0x20，即空格)是源文献中唯一容许浮现空白字符，这意味着：

所有其他字符串中空白字符都要进行转义。

制表符不用于缩进。

2.3.2特殊转义序列

对于具备特殊转义序列任何字符(\b，\t，\n，\f，\r，\“，\‘及\)，咱们使用它转义序列，而不是相应八进制(例如\012)或Unicode(例如\u000a)转义。

2.3.3非ASCII字符

对于剩余非ASCII字符，是使用实际Unicode字符(例如∞)，还是使用等价Unicode转义符(例如\u221e)，取决于哪个能让代码更易于阅读和理解。

Tip：在使用Unicode转义符或是某些实际Unicode字符时，建议做些注释给出解释，这有助于别人阅读和理解。

例如：

StringunitAbbrev=μs；|赞，虽然没有注释也非常清晰

StringunitAbbrev=\u03bcs；//μs|容许，但没有理由要这样做

StringunitAbbrev=\u03bcs；//Greeklettermu，s|容许，但这样做显得笨拙还容易出错

StringunitAbbrev=\u03bcs；|很糟，读者主线看不出这是什么

return\ufeff+content；//byteordermark|Good，对于非打印字符，使用转义，并在必要时写上注释

Tip：永远不要由于胆怯某些程序也许无法对的解决非ASCII字符而让你代码可读性变差。当程序无法对的解决非ASCII字符时，它自然无法对的运营，你就会去fix这些问题了。(言下之意就是大胆去用非ASCII字符，如果真有需要话)

源文献构造

一种源文献包括(按顺序地)：

允许证或版权信息(如有需要)

package语句

import语句

一种顶级类(只有一种)

以上每个某些之间用一种空行隔开。

3.1允许证或版权信息

如果一种文献包括允许证或版权信息，那么它应当被放在文献最前面。

3.2package语句

package语句不换行，列限制(4.4节)并不合用于package语句。(即package语句写在一行里)

3.3import语句

3.3.1import不要使用通配符

即，不要浮现类似这样import语句：importjava.util.*;

3.3.2不要换行

import语句不换行，列限制(4.4节)并不合用于import语句。(每个import语句独立成行)

3.3.3顺序和间距

import语句可分为如下几组，按照这个顺序，每组由一种空行分隔：

所有静态导入独立成组

com.googleimports(仅当这个源文献是在com.google包下)

第三方包。每个顶级包为一组，字典序。例如