Google Java Style Guide

• 语言: 英语
• 格式: .pdf
• 来源: github.com/fgaray

摘要

《Google Java Style Guide》是Google公司为Java编程语言制定的编码规范指南。该文档详细规定了Java源代码的格式、命名约定、注释风格、修饰符顺序、数字字面量的使用、异常处理、文件结构等内容。其核心目标是提高代码的可读性和可维护性，同时确保遵循明确的规则。文档强调了避免使用主观建议，而是采用可执行的规则，并提供了具体的示例以帮助理解和应用这些规范。

AI总结

### 《Google Java Style Guide》总结

#### 1. 引言
- 本指南定义了Google的Java编码标准，适用于所有Java源文件。
- 主要涵盖格式、命名规范、编程实践等内容，重点强调可 enforcement 的规则，避免主观建议。
- 文档中的术语：
- **类**：包括普通类、枚举类、接口和注解。
- **注释**：仅指实现注释，不使用“文档注释”一词，统一称为“Javadoc”。

#### 2. 命名规范
- **标识符**：
- 仅使用ASCII字母、数字和小部分允许的下划线。
- 不使用特殊前缀或后缀（如`name_`、`mName`等）。
- **包名**：
- 全部小写，单词直接拼接，无下划线。例如：`com.example.deepspace`。
- **类名**：
- 使用UpperCamelCase，通常是名词或名词短语。例如：`Character`、`immutableList`。
- **字段名**：
- 静态或非静态字段使用lowerCamelCase，通常是名词或名词短语。例如：`computedValues`。
- **参数名**：
- 使用lowerCamelCase，避免在公共方法中使用单字母参数名。
- **局部变量名**：
- 使用lowerCamelCase，即使变量是`final`且不可变，也不视为常量。
- **类型变量名**：
- 使用单字母（如`E`、`T`）或类名加`T`（如`RequestT`）。
- **驼峰命名法**：
- 转换规则：将英文短语转为小写，拆分单词，首字母大写（上驼峰）或除第一个单词外其余首字母大写（下驼峰）。

#### 3. 编程实践
- **`@Override`**：
- 在合法情况下必须使用`@Override`注解，除父方法已标记为`@Deprecated`的情况。
- **异常处理**：
- 除非有充分理由，否则不能忽略捕获的异常，应在注释中说明原因。

#### 4. 源文件结构
- 源文件顺序：
1. 版权或版权声明（如有）。
2. 包声明。
3. 导入语句。
4. 单个顶级类。
- 每个部分之间用一个空行分隔。

#### 5. 其他规则
- **文件编码**：
- 源文件使用UTF-8编码。
- **空格和制表符**：
- 只允许ASCII空格，禁止使用制表符缩进。
- **注释风格**：
- 块注释使用`/* ... */`，行注释使用`//`，避免对齐格式（horizontal alignment）。
- **括号使用**：
- 可选括号仅在明确无歧义时省略。
- **枚举类**：
- 枚举常量后逗号后的换行是可选的，允许额外空行。
- **字符串和字符**：
- 特殊字符使用转义序列，非ASCII字符可直接使用或转义，以提高可读性。

#### 6. 格式和可读性
- **行长度**：
- 最大限制为100列，超出时需换行。
- **对齐**：
- 对齐格式（如代码对齐）不强制要求，但需避免因对齐导致的维护问题。
- **注释**：
- 块注释和行注释需与代码对齐，避免使用盒子样式（如`*`包围）。

#### 7. 总结
《Google Java Style Guide》为Java开发提供了全面且明确的编码规范，旨在提高代码的一致性、可读性和可维护性。核心内容包括命名规范、文件结构、编程实践和格式规则，适用于所有Google Java项目。