1 简介
本文档是 Google 对 Java™ 编程语言源代码编码规范的完整定义。当且仅当 Java 源文件遵循本文档中的规则时,才被认为符合 Google 风格。
与其他编程风格指南类似,本文档涵盖的内容不仅包括格式化方面的美学问题,还包括其他类型的约定或编码标准。然而,本文档主要关注我们普遍遵循的硬性规则,并避免给出无法明确执行(无论是通过人工还是工具)的建议。
1.1 术语说明
在本文档中,除非另有说明:
- 术语类(class)泛指普通类、记录类(record class)、枚举类(enum
class)、接口(interface)或注解类型(annotation
type,
@interface)。 - 术语成员(member,指类的成员)泛指嵌套类、字段、方法或构造函数;即类的所有顶层内容,初始化器除外。
- 术语注释(comment)始终指实现注释。我们不使用”文档注释”这一说法,而是使用通用术语”Javadoc”。
其他”术语说明”将在文档中不定期出现。
1.2 指南说明
本文档中的示例代码是非规范性的。也就是说,虽然示例符合 Google 风格,但它们可能并不是表达代码的唯一优雅方式。示例中做出的可选格式化选择不应作为规则强制执行。
Last updated on