Google Java Style

最新推荐文章于 2024-08-26 16:40:46 发布

yzmyyff

最新推荐文章于 2024-08-26 16:40:46 发布

阅读量708

点赞数

文章标签： google java 编码规范

Google Java Style

起因

本文的起因是公司需要一份编码规范，网上的中文翻译好像没有对应到最新的版本，所以在参考已有中文翻译的基础上稍作改动。
已有的中文翻译：http://www.hawstein.com/posts/google-java-style.html
Google Java Style原文：
https://google-styleguide.googlecode.com/svn/trunk/javaguide.html
以下为翻译正文。

介绍
1.1 术语说明
1.2 指南说明
源文件基础
2.1 文件名
2.2 文件编码：UTF-8
2.3 特殊字符
2.3.1 空白字符
2.3.2 特殊转义序列
2.3.3 非ASCII字符
源文件结构
3.1 许可证和版权信息（如有需要）
3.2 包声明
3.3 导入声明
3.3.1 不要使用通配符导入
3.3.2 不要换行
3.3.3 顺序和间距
3.4 类声明
3.4.1 只有一个顶级类声明
3.4.2 类成员顺序
格式化
4.1 大括号
4.1.1 在任何可用的地方使用大括号
4.1.2 非空块：K&R风格
4.1.3 空块：可以用简洁版本
4.2 块缩进：+2空格
4.3 每行一条语句
4.4 列限制：80或者100
4.5 换行
4.5.1 从哪里断开
4.5.2 换行时缩进至少+4个空格
4.6 空格
4.6.1 垂直空格
4.6.2 水平空格
4.6.3 水平对齐：不要求
4.7 分组括号：推荐
4.8 具体结构
4.8.1 枚举类
4.8.2 变量声明
4.8.3 数组
4.8.4 switch语句
4.8.5 注解
4.8.6 注释
4.8.7 修饰词
4.8.8 修饰词
命名
5.1 对所有标识符都通用的规则
5.2 特定类型标识符的规则
5.2.1 包名
5.2.2 类名
5.2.3 方法名
5.2.4 常量名
5.2.5 非常量字段名
5.2.6 参数名
5.2.7 局部变量名
5.2.8 类型变量名
5.3 驼峰式命名法定义
编程实践
6.1 总是使用@Override
6.2 不要忽略捕获异常
6.3 使用类名调用静态变量
6.4 不要使用Finalizers
javadoc
7.1 格式化
7.1.1 一般形式
7.1.2 段落
7.1.3 @语句
7.2 摘要片段
7.3 何时使用javadoc
7.3.1 例外：不言自明的方法
7.3.2 例外：重载

1 介绍

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

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

1.1 术语说明

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

术语类可表示一个普通类，枚举类，接口或是注解类型(@interface)
术语注释只用来指代实现的注释，我们不使用“文档注释”一词，而是用Javadoc。
其他的术语说明会偶尔在后面的文档出现。

1.2 指南说明

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

2 源文件基础

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)，取决于哪个能让代码更易于阅读和理解。

Tips：在使用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，对于非打印字符，使用转义，并在必要时写上注释

Tips：永远不要由于害怕某些程序可能无法正确处理非ASCII字符而让你的代码可读性变差。当程序无法正确处理非ASCII字符时，它自然无法正确运行，你就会去fix这些问题的了。

3 源文件结构

一个源文件包含(按顺序地)：

许可证或版权信息(如有需要)
package语句
import语句
一个顶级类(只有一个)

以上每个部分之间用一个空行隔开。

3.1 许可证和版权信息（如有需要）

如果一个文件包含许可证或版权信息，那么它应当被放在文件最前面。

3.2 包声明

package语句不换行，列限制(4.4节，列限制：80或者100)并不适用于package语句。

3.3 导入声明

3.3.1 不要使用通配符导入

尽量不要使用通配符导入，静态导入等。

3.3.2 不要换行

import语句不换行，列限制(4.4节，列限制：80或者100)并不适用于import语句。

3.3.3 顺序和间距

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

所有的静态导入独立成组
com.google导入(仅当这个源文件是在com.google包下)
第三方的包。每个顶级包为一组，字典序。
-例如：android, com, junit, org, sun
java导入
javax导入

组内不空行，按字典序排列。

3.4 类声明

3.4.1 只有一个顶级类声明

每个顶级类都在一个与它同名的源文件中。

3.4.2 类成员顺序

类的成员顺序对易学性有很大的影响，但这也不存在唯一的通用法则。不同的类对成员的排序可能是不同的。最重要的一点，每个类应该以某种逻辑去排序它的成员，维护者应该要能解释这种排序逻辑。比如，新的方法不能总是习惯性地添加到类的结尾，因为这样就是按时间顺序而非某种逻辑来排序的。

3.4.2.1 重载：永不分离

当一个类有多个构造函数，或是多个同名方法，这些函数/方法应该按顺序出现在一起，中间不要放进其它函数/方法。

4 格式化

术语说明：类块状结构(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”):

左大括号前不换行
左大括号后换行
右大括号前换行
如果右大括号是一个语句、函数体或类的终止，则右大括号后换行; 否则不换行。例如，如果右大括号后面是else或逗号，则不换行。

示例：

return new MyClass() {
  @Override public void method() {
    if (condition()) {
      try {
        something();
      } catch (ProblemException e) {
        recover();
      }
    }
  }
};

4.8.1节枚举类给出了枚举类的一些例外。

4.1.3 空块：可以用简洁版本

一个空的块状结构里什么也不包含，大括号可以简洁地写成{}，不需要换行。例外：如果它是一个多块语句的一部分(if/else 或 try/catch/finally) ，即使大括号内没内容，右大括号也要换行。
示例：

void doNothing() {}

4.2 块缩进：+2空格

每当开始一个新的块，缩进增加2个空格，当块结束时，缩进返回先前的缩进级别。缩进级别适用于代码和注释。(见4.1.2节非空块：K&R风格中的代码示例)

4.3 每行一条语句

每个语句后要换行。

4.4 列限制：80或者100

一个项目可以选择一行80个字符或100个字符的列限制，除了下述例外，任何一行如果超过这个字符数限制，必须按照4.5节换行中所述换行。

例外：
1. 不可能满足列限制的行(例如，Javadoc中的一个长URL，或是一个长的JSNI方法引用)。
2. package和import语句(见3.2节包声明和3.3节导入声明)。
3. 注释中那些可能被剪切并粘贴到shell中的命令行。

4.5 换行

术语说明：一般情况下，一行长代码为了避免超出列限制(80或100个字符)而被分为多行，我们称之为换行。

我们并没有全面，确定性的准则来决定在每一种情况下如何自动换行。很多时候，对于同一段代码会有好几种有效的自动换行方式。

Tip: 提取方法或局部变量可以在不换行的情况下解决代码过长的问题。

4.5.1 从哪里断开

自动换行的基本准则是：更倾向于在更高的语法级别处断开。

如果在非赋值运算符处断开，那么在该符号前断开。注意：这一点与Google其它语言的编程风格不同(如C++和JavaScript)。
- 这条规则也适用于以下“类运算符”符号：点分隔符(.)，类型界限中的&（<T extends Foo & Bar>)，catch块中的管道符号(catch (FooException | BarException e)
如果在赋值运算符处断开，通常的做法是在该符号后断开，任一种方法都可行。
- 这条规则也适用于for(“foreach”)中的赋值操作中的分号。
方法名或构造函数名与左括号(()留在同一行。
逗号(,)与其前面的内容留在同一行。

4.5.2 换行时缩进至少+4个空格

换行时，第一行后的每一行至少比第一行多缩进4个空格。

当存在连续换行时，缩进可能会多缩进不只4个空格。一般而言，两个连续行使用相同的缩进当且仅当它们开始于同级语法元素。

第4.6.3水平对齐一节中指出，不鼓励使用可变数目的空格来对齐前面行的符号。

4.6 空格

4.6.1 垂直空格

以下情况需要使用一个空行：

类内连续的成员之间：字段，构造函数，方法，嵌套类，静态初始化块，实例初始化块。
- 例外：两个连续字段之间的空行是可选的，用于字段的空行主要用来对字段进行逻辑分组。
在函数体内，语句的逻辑分组间使用空行。
类内的第一个成员前或最后一个成员后的空行是可选的(既不鼓励也不反对这样做，视个人喜好而定)。
要满足本文档中其他节的空行要求(比如3.3节：import声明)

多个连续的空行是允许的，但没有必要这样做(我们也不鼓励这样做)。

4.6.2 水平空格

除了语言需求和其它规则，并且除了文字，注释和Javadoc用到单个空格，单个ASCII空格也出现在以下几个地方：

分隔任何保留字与紧随其后的左括号(()(如if, for catch等)。
分隔任何保留字与其前面的右大括号(})(如else, catch)。
在任何左大括号前({)，有两个例外：
- @SomeAnnotation({a, b})(不使用空格)。
- String[][] x = {{"foo"}};(大括号{{间没有空格，见下面第8条)。
在任何二元或三元运算符的两侧。这也适用于以下“相似运算符”符号：
- 连接类型所使用的&符号(<T extends Foo & Bar>)。
- catch块中用于处理多个异常的管道符号: catch (FooException | BarException e)。
- foreach语句中的冒号。
在, : ;及右括号())后
如果在一条语句后做注释，则双斜杠(//)两边都要空格。这里可以允许多个空格，但并不要求。
声明语句中的类型和变量之间：List<String> list。
数组初始化中，大括号内的空格是可选的。
- 即new int[] {5, 6}和new int[] { 5, 6 }都是可以的。

Note：这个规则并不要求或禁止一行的开关或结尾需要额外的空格，只对内部空格做要求。

4.6.3 水平对齐：不要求

术语说明：水平对齐指的是通过增加可变数量的空格来使某一行的字符与上一行的相应字符对齐。

这是允许的，但Google编程风格对此不做要求。即使对于已经使用水平对齐的代码，我们也不需要去保持这种风格。

以下示例先展示未对齐的代码，然后是对齐的代码：

private int x; // this is fine
private Color color; // this too

private int   x;      // permitted, but future edits
private Color color;  // may leave it unaligned

Tip：对齐可增加代码可读性，但它为日后的维护带来问题。考虑未来某个时候，我们需要修改一堆对齐的代码中的一行。这可能导致原本很漂亮的对齐代码变得错位。很可能它促使编码者(可能就是你)调整周围代码的空白来使这一堆代码重新水平对齐。一行代码的改变像炸弹一样形成了”爆炸半径“。这就会让你做许多的无用功，影响版本历史信息，增加了审查者的工作并且可能导致更多的合并冲突。

4.7 分组括号：推荐

除非作者和代码审查员都认为去掉小括号也不会使代码被误解，或是去掉小括号能让代码更易于阅读，否则我们不应该去掉小括号。我们没有理由假设读者能记住整个Java运算符优先级表。

4.8 具体结构

4.8.1 枚举类

枚举常量间用逗号隔开，也可以使用换行。

没有方法和文档的枚举类可写成数组初始化的格式(见4.8.3.1节数组初始化)：

private enum Suit { CLUBS, HEARTS, SPADES, DIAMONDS }

由于枚举类也是一个类，因此所有适用于其它类的格式规则也适用于枚举类。

4.8.2 变量声明

4.8.2.1 每行声明一个变量

不要使用组合声明，比如int a, b;。

4.8.2.2 需要时才声明并尽快初始化

不要在一个代码块的开头习惯性的把局部变量一次性都声明了，而是在第一次需要使用它时才声明，并最小化他们的作用范围。局部变量在声明时最好就进行初始化，或者声明后尽快进行初始化。

4.8.3 数组

4.8.3.1 数组初始化：可写成块状结构

数组初始化可以写成块状结构，比如，下面的写法都是OK的(并为穷举所有可能)：

new int[] {           new int[] {
  0, 1, 2, 3            0,
}                       1,
                        2,
new int[] {             3,
  0, 1,               }
  2, 3
}                     new int[]
                          {0, 1, 2, 3}

4.8.3.2 非C风格数组声明

中括号是类型的一部分，而不是变量的一部分：String[] args，而非String args[]。

4.8.4 switch语句

术语说明：switch块的大括号内是一个或多个语句组。每个语句组包含一个或多个switch标签(case FOO:或default:)，后面跟着一条或多条语句。

4.8.4.1 非C风格数组声明

与其它块状结构一致，switch块中的内容缩进为2个空格。

switch一个标签结束后，重启一行，缩进级别+2，就好像语句块开始。下一个switch标签返回到之前的缩进级别，就像语句块结束。

4.8.4.2 Fall-through：注释

在一个switch块内，每个语句组要么通过break, continue, return或抛出异常来终止，要么通过一条注释来说明程序将继续执行到下一个语句组，任何能表达这个意思的注释都是OK的(典型的是用// fall through)。这个特殊的注释并不需要在最后一个语句组(一般是default)中出现。示例：

switch (input) {
  case 1:
  case 2:
    prepareOneOrTwo();
    // fall through
  case 3:
    handleOneTwoOrThree();
    break;
  default:
    handleLargeNumber(input);
}

4.8.4.3 default分支需要写出来

每个switch语句都包含一个default语句组，即使它什么代码也不包含。

4.8.5 注解

注解紧跟在文档块后面，应用于类、方法和构造函数，一个注解独占一行。这些换行不属于自动换行(第4.5节，换行)，因此缩进级别不变。例如：

@Override
@Nullable
public String getNameIfPresent() { ... }

例外：只有一个的注解可以和签名的第一行出现在同一行。例如：

@Override public int hashCode() { ... }

应用于字段的注解紧随文档块出现，应用于字段的多个注解允许与字段出现在同一行。例如：

@Partial @Mock DataLoader loader;

参数和局部变量注解没有特定规则。

4.8.6 注释

4.8.6.1 块注释风格

块注释与其周围的代码在同一缩进级别。它们可以是/* ... */风格，也可以是// ...风格。对于多行的/* ... */注释，后续行必须从*开始，并且与前一行的*对齐。以下示例注释都是OK的。

/*
 * This is          // And so           /* Or you can
 * okay.            // is this.          * even do this. */
 */

注释不要封闭在由星号或其它字符绘制的框架里。

Tip：在写多行注释时，如果你希望自动代码格式化能在需要时自动换行(即注释像段落风格一样)，那么使用/* ... */。绝大多数格式化工具不能自动格式化//...风格注释。

4.8.7 修饰词

类和成员的修饰词如果存在，则按Java语言规范中推荐的顺序出现。

public protected private abstract static final transient volatile synchronized native strictfp

4.8.8 数字文本

long-在整型文本后加一个L作为后缀，绝对不要使用小写(防止和数字1混淆)。如使用3000000000L而不是3000000000l。

5 命名

5.1 对所有标识符都通用的规则

标识符只能使用ASCII字母和数字，和下面两个例子中提到的下划线。因此每个有效的标识符名称都能匹配正则表达式\w+。

在Google其它编程语言风格中使用的特殊前缀或后缀，如name_，mName，s_name和kName，在Java编程风格中都不要使用。

5.2 特定类型标识符的规则

5.2.1 包名

包名全部小写，连续的单词只是简单地连接起来(不使用下划线)。例如：com.example.deepspace，既不是com.example.deepSpace也不是com.example.deep_space。

5.2.2 类名

类名都以UpperCamelCase风格编写。

类名通常是名词或名词短语，例如Character或者ImmutableList，接口名称可能也是名词或者名词短语(例如List)，有时也可用形容词或形容词短语替代(如Readable)。

现在还没有特定的规则或行之有效的约定来命名注解类型。

测试类的命名以它要测试的类的名称开始，以Test结束。例如，HashTest或HashIntegrationTest。

5.2.3 方法名

方法名都以lowerCamelCase风格编写。

方法名通常是动词或动词短语。例如sendMessage 或stop。

下划线可能出现在JUnit 测试方法名称中用以分隔名称的逻辑组件。一个典型的模式是：test<MethodUnderTest>_<state>，例如testPop_emptyStack。并不存在唯一正确的方式来命名测试方法。

5.2.4 常量名

常量名命名模式为CONSTANT_CASE，全部字母大写，用下划线分隔单词。那到底什么算是一个常量？

每个常量都是一个static final字段，但不是所有static final字段都是常量。在决定一个字段是否是一个常量时，考虑它是否真的感觉像是一个常量。例如，如果任何一个该实例的观测状态是可变的，则它几乎肯定不会是一个常量。只是打算绝不改变对象一般是不够的，它要真的一直不变才能将它示为常量。

// Constants
static final int NUMBER = 5;
static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann");
static final Joiner COMMA_JOINER = Joiner.on(',');  // because Joiner is immutable
static final SomeMutableType[] EMPTY_ARRAY = {};
enum SomeEnum { ENUM_CONSTANT }

// Not constants
static String nonFinal = "non-final";
final String nonStatic = "non-static";
static final Set<String> mutableCollection = new HashSet<String>();
static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable);
static final Logger logger = Logger.getLogger(MyClass.getName());
static final String[] nonEmptyArray = {"these", "can", "change"};

这些名字通常是名词或名词短语。

5.2.5 非常量字段名

非常量字段名以lowerCamelCase风格编写。

这些名字通常是名词或名词短语。例如computedValues或者index。

5.2.6 参数名

参数名以lowerCamelCase风格编写。

参数应该避免用单个字符命名。

5.2.7 局部变量名

局部变量名以lowerCamelCase风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。

虽然缩写更宽松，但还是要避免用单字符进行命名，除了临时变量和循环变量。

即使局部变量是final和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。

5.2.8 类型变量名

类型变量可用以下两种风格之一进行命名：

单个的大写字母，后面可以跟一个数字(如：E, T, X, T2)。
以类命名方式(5.2.2节)，后面加个大写的T(如：RequestT, FooBarT)。

5.3 驼峰式命名法定义

有时，我们有不止一种合理的方式将一个英语词组转换成驼峰形式，如缩略语或不寻常的结构(例如”IPv6”或”iOS”)。为了提高可预见性，Google规范指定了以下的转换方案。

名字从散文形式(prose form)开始:

把短语转换为纯ASCII码，并且移除任何撇号。例如：”Müller’s algorithm”将变成”Muellers algorithm”。
把这个结果切分成单词，在空格或其它标点符号(通常是连字符)处分割开。
- 推荐：如果某个单词已经有了常用的驼峰表示形式，按它的组成将它分割开(如”AdWords”将分割成”ad words”)。需要注意的是”iOS”并不是一个真正的驼峰表示形式，它未遵循任何转换规则，因此该推荐对它并不适用。
现在将所有字母都小写(包括缩写)，然后将单词的第一个字母大写：
- 每个单词的第一个字母都大写，来得到UpperCamelCase。
- 除了第一个单词，每个单词的第一个字母都大写，来得到lowerCamelCase。
最后将所有的单词连接起来得到一个标识符。

请注意原词的前后缀等信息均被忽略，示例：

Prose form	Correct	Incorrect
“XML HTTP request”	XmlHttpRequest	XMLHTTPRequest
“new customer ID”	newCustomerId	newCustomerID
“inner stopwatch”	innerStopwatch	innerStopWatch
“supports IPv6 on iOS?”	supportsIpv6OnIos	supportsIPv6OnIOS
“YouTube importer”	YouTubeImporter	YoutubeImporter*

*可以接受，但不推荐。

注意：在英语中，某些带有连字符的单词形式不唯一。例如：”nonempty”和”non-empty”都是正确的，因此方法名heckNonempty和checkNonEmpty也都是正确的。

6 编程实践

6.1 总是使用@Override

只要是合法的，就把@Override注解给用上。包含了一个类重载超类方法，一个类实现接口方法和一个接口方法重新指定一个超接口方法这几种情况。

例外：在父方法是@Deprecated的时候@Override可以省略。

6.2 不要忽略捕获异常

除了下面的例子，对捕获的异常不做响应是极少正确的。(典型的响应方式是打印日志，或者如果它被认为是不可能的，则把它当作一个AssertionError重新抛出。)

如果它确实是不需要在catch块中做任何响应，需要做注释加以说明。

try {
  int i = Integer.parseInt(response);
  return handleNumericResponse(i);
} catch (NumberFormatException ok) {
  // it's not numeric; that's fine, just continue
}
return handleTextResponse(response);

例外：在测试中，如果一个捕获的异常被命名为expected，则它可以被不加注释地忽略。下面是一种非常常见的情形，用以确保所测试的方法会抛出一个期望中的异常，因此在这里就没有必要加注释。

try {
  emptyStack.pop();
  fail();
} catch (NoSuchElementException expected) {
}

6.3 使用类名调用静态变量

如果需要调用一个类的静态成员，最好通过类的名称调用，而不是具体某个对象或表达式。

Foo aFoo = ...;
Foo.aStaticMethod(); // good
aFoo.aStaticMethod(); // bad
somethingThatYieldsAFoo().aStaticMethod(); // very bad

6.4 不要使用Finalizers

极少会去重载Object.finalize。

Tip：不要使用finalize。如果你非要使用它，请先仔细阅读和理解Effective Java 第7条款：“Avoid Finalizers”，然后不要使用它。

7 javadoc

7.1 格式化

7.1.1 一般形式

Javadoc块的基本格式如下所示：

/**
 * Multiple lines of Javadoc text are written here,
 * wrapped normally...
 */
public int method(String p1) { ... }

或者是以下单行形式：

/** An especially short bit of Javadoc. */

基本格式总是OK的。当整个Javadoc块能容纳于一行时(且没有Javadoc标记@XXX)，可以使用单行形式。

7.1.2 段落

空行(即，只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。除了第一个段落，每个段落第一个单词前都有标签<p>，并且它和第一个单词间没有空格。

7.1.3 @语句

标准的Javadoc标记按以下顺序出现：@param, @return, @throws, @deprecated, 前面这4种标记如果出现，描述都不能为空。当描述无法在一行中容纳，连续行需要从@位置至少再缩进4个空格。

7.2 摘要片段

每个类或成员的Javadoc以一个简短的摘要片段开始。这个片段是非常重要的，在某些情况下，它是唯一出现的文本，比如在类和方法索引中。

这只是一个小片段，可以是一个名词短语或动词短语，但不是一个完整的句子。它不会以A {@code Foo} is a...或This method returns...开头, 它也不会是一个完整的祈使句，如Save the record...。然而，由于开头大写及被加了标点，它看起来就像是个完整的句子。

Tip：一个常见的错误是把简单的Javadoc写成/** @return the customer ID */，这是不正确的。它应该写成/** Returns the customer ID. */。

7.3 何时使用javadoc

至少在每个public类及它的每个public和protected成员处使用Javadoc，以下是一些例外。

其他类和成员根据需要也应该有javadoc。无论何时一个注释用来描述一个类，方法或者字段的整体作用或者行为时，这个注释用javadoc形式书写。(这种形式更统一，更易于结合工具。)

7.3.1 例外：不言自明的方法

对于简单明显的方法如getFoo，Javadoc是可选的(即，是可以不写的)。这种情况下除了写“Returns the foo”，确实也没有什么值得写了。

Tip：如果有一些相关信息是需要读者了解的，那么以上的例外不应作为忽视这些信息的理由。例如，对于方法名getCanonicalName，就不应该忽视文档说明，因为读者很可能不知道词语canonical name指的是什么。

7.3.2 例外：重载

如果一个方法重载了超类中的方法，那么Javadoc并非必需的。

yzmyyff

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Google Java Style

Google Java Style起因本文的起因是公司需要一份编码规范，网上的中文翻译好像没有对应到最新的版本，所以在参考已有中文翻译的基础上稍作改动。已有的中文翻译：http://www.hawstein.com/posts/google-java-style.html Google Java Style原文：https://google-styleguide.googleco
复制链接

扫一扫