Google编程规范专业资料.docVIP

GoogleJava编程风格指南

January20,2023

作者：Hawstein

出处：

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

目录

前言

源文献基础

源文献结构

格式

命名约定

编程实践

Javadoc

后记

前言

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

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

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.googleim