Google Java 编程规范(中文版)
说明
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.
package语句
3.3.
import语句
3.3.1.
import不要使用通配符
3.3.2.
不要换行
3.3.3.
顺序和间距
3.4.
类声明
3.4.1.
只有一个顶级类声明
3.4.2.
类成员顺序
4.
格式
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.
注解(Annotations)
4.8.6.
注释
4.8.7.
Modifiers
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.
驼峰式命名法(CamelCase)
6.
编程实践
6.1.
@Override:能用则用
6.2.
捕获的异常:不能忽视
6.3.
静态成员:使用类进行调用
6.4.
Finalizers: 禁用
7.
Javadoc
7.1.
格式
7.1.1.
一般形式
7.1.2.
段落
7.1.3.
Javadoc标记
7.2.
摘要片段
7.3.
哪里需要使用Javadoc
7.3.1.
例外:不言自明的方法
7.3.2.
例外:重载
7.3.3.
可选的Javadoc
Powered by
GitBook
Google Java 编程规范(中文版)
4.4 列限制:80或100
一个项目可以选择一行80个字符或100个字符的列限制,除了下述例外,任何一行如果超过这个字符数限制,必须自动换行。
例外:
不可能满足列限制的行(例如,Javadoc中的一个长URL,或是一个长的JSNI方法参考)。
package
和
import
语句(见3.2节和3.3节)。
注释中那些可能被剪切并粘贴到shell中的命令行。