Google Java Style Guide

《Google Java Style Guide》是Google为Java语言编写的编码标准文档，涵盖了代码格式、命名约定、注释等方面的详细规则，确保代码风格的一致性和可读性。以下是该文档的核心内容总结： ### 1. **文件基础** - **文件名**：源文件名与其包含的 topl级类名一致，扩展名为`.java`。 - **编码**：源文件使用UTF-8编码。 - **特殊字符**： yasak控 制字符除了回车，水平空格为唯一允许的空白字符，禁止使用制表符。 ### 2. **格式规范** - **缩进**：每个块或块类结构缩进2个空格，块内代码和注释保持一致缩进。 - **行长度**：单行代码不得超过100个字符，超过需要换行。 - **换行**：代码超过列限制需换行，换行方式因情况而定，未超过列限制的代码也可按需换行。 - **空白**：Coder可以选择对齐相关Token，但不强制要求，保持可读性即可。 ### 3. **命名约定** - **包名**：全小写，不含下划线，单词连续拼接。 - **类名**：采用大驼峰式命名，通常为名词或名词短语。 - **接口名**：同类名，允许为形容词或形容词短语。 - **常量**：大写，单词间下划线分隔。 - **非常量字段名**：小驼峰式，通常名词或名词短语。 - **参数名**：小驼峰式，公共方法可避免单字符参数。 - **局部变量名**：同上，不考虑是否final或不可变。 - **类型变量名**：单大写字母加数字，或大驼峰式类名加T。 ### 4. **注释** - **块注释**：与代码相同缩进，`/*...*/`或`//`形式，多行`/*`注释`*`对齐。 - **行注释**：双斜线，不适合长篇说明。 ### 5. **具体结构** - **枚举类**：常量逗号后可换行，每常量单独一行或同行。 - **数字字面量**：长整型以大写L结尾，避免与小写l混淆。 - **修饰符顺序**：遵循JLS建议顺序。 - **括号分组**：除作者与评审同意见外，必要时用括号明确表达。 - **开关控制结构**： - `switch`包含`default`分支，即使无代码。 - 简单情况可用`if`代替`switch`。 ### 6. **编程实践** - **`@Override`**：重写方法时必用（放弃过时方法外）。 - **异常处理**：捕捉异常后避免无操作，除非有明确理由。 - **耗时操作**：避免在高负载代码路径使用可变性能装盒。 通过遵循以上规范，Google Java Style Guide 帮助开发者编写清晰、规范、易于维护的代码，确保代码在团队中的一致性和可读性。