Google 开源项目风格指南
latest
Google 开源项目风格指南——中文版
C++ 风格指南 - 内容目录
Objective-C 风格指南 - 内容目录
Python 风格指南 - 内容目录
Shell 风格指南 - 内容目录
Javascript 风格指南 - 内容目录
TypeScript 风格指南
HTML/CSS 风格指南 - 内容目录
Java 风格指南 - 内容目录
0. 扉页
1. 介绍
2. 源文件基础
3. 源文件结构
4. 格式
5. 命名
6. 编程习惯
7. Javadoc
Google 开源项目风格指南
Java 风格指南 - 内容目录
Edit on GitHub
Java 风格指南 - 内容目录
¶
0. 扉页
1. 介绍
1.1. 术语说明
1.2. 指南说明
2. 源文件基础
2.1. 文件名
2.2. 文件编码:UTF-8
2.3. 特殊字符
2.3.1. 空白字符
2.3.2 特殊转义序列
2.3.3. 非ASCII字符
3. 源文件结构
3.1. 许可或版权信息(如果有的话)
3.2. 包声明
3.3. 导入语句
3.3.1. 不使用通配符导入
3.3.2. 不换行
3.3.3. 排序和间距
3.3.4. 不对类使用静态导入
3.4. 类的声明
3.4.1. 有且仅有一个顶级类声明
3.4.2. 类中内容的顺序
3.4.2.1. 重载:永不分割
4. 格式
4.1. 花括号
4.1.1. 选择性的花括号的使用
4.1.2. 非空块:K & R 风格
4.1.3. 空代码块:应简洁表示
4.2. 代码块缩进:增加2个空格
4.3. 一行一个语句
4.4. 列限制: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.2.1. 一次只声明一个变量
4.8.2.2. 按需声明
4.8.3. 数组
4.8.3.1. 数组初始化器:可以是“块状”的
4.8.3.2. 不要使用C语言风格的声明
4.8.4. switch语句
4.8.4.1. 缩进
4.8.4.2. 贯穿:需要注释
4.8.4.3. 必须要有
default
标签
4.8.5. 注解
4.8.5.1. 类型注解
4.8.5.2. 类注解
4.8.5.3. 方法/构造函数注解
4.8.5.4. 字段注解
4.8.5.5. 参数/局部变量注解
4.8.6. 注释
4.8.6.1. 块状注释
4.8.7. 修饰符
4.8.8. 数值字面量
5. 命名
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. 编程习惯
6.1
@Override
:始终使用
6.2. 捕获的异常:不应忽略
6.3. 静态成员:使用类名进行限定
6.4. 析构方法:不使用
7. Javadoc
7.1. 格式
7.1.1. 一般形式
7.1.2. 段落
7.1.3. 块标签
7.2. 摘要片段
7.3. Javadoc的使用位置
7.3.1. 例外:不言自明的成员
7.3.2. 例外:重写
7.3.4. 非必需的Javadoc(译者注:原文中并没有7.3.3节)
Read the Docs
v: latest
Versions
latest
stable
dev
Downloads
pdf
epub
On Read the Docs
Project Home
Builds