官方文档:Google Java Style
中文翻译版:Google Java编程风格指南, Hawstein's Blog
可以先看官方文档,遇到不确定有疑问的,可以再对照翻译版本阅读,加深理解。
记录两个以前没有注意到点。
包名称全部是小写字母,简单地将连续单词连接在以前(没有下划线)。
例如:用 com.example.deepspace, 而不是 com.example.deepSpace 或 com.example.deep_space.
以短语形式开头的名称:
- 把短语转换为纯ASCII码,并且移除任何单引号。例如:”Müller’s algorithm”将变成”Muellers algorithm”。
- 把这个结果切分成单词,在空格或其它标点符号(通常是连字符)处分割开。
- 推荐:如果某个单词已经有了常用的驼峰表示形式,按它的组成将它分割开(如”AdWords”将分割成”ad words”)。 需要注意的是”iOS”并不是一个真正的驼峰表示形式,它违反了约定,因此本推荐对它并不适用。
- 将所有字母都小写(包括缩写),然后将单词的第一个字母大写:
- 每个单词首字母大写,得到大驼峰式命名 ( UpperCamelCase )
- 除了第一个单词,其他每个单词首字母大写,得到小驼峰式命名 ( lowerCamelCase )
- 最后,将所有单词链接起来,得到一个表示符.
例子
Prose form | Correct | Incorrect |
---|---|---|
"XML HTTP request" | XmlHttpRequest |
XMLHTTPRequest |
"new customer ID" | newCustomerId |
newCustomerID |
"inner stopwatch" | innerStopwatch |
innerStopWatch |
"supports IPv6 on iOS?" | supportsIpv6OnIos |
supportsIPv6OnIOS |
"YouTube importer" | YouTubeImporter YoutubeImporter * |
* 表示可以,但不推荐。