翻译状态: 完成进度82%
本文的英文原始文档(Android Code Style Guidelines for Contributors)地址 : http://source.android.com/source/code-style.html
国内用户如果无法直接访问,请自行翻墙。第一次翻译Java类的文档, 如果有差错和不妥之处, 请不吝指出.
Android的代码风格规则
The rules below are not guidelines or recommendations, but strict rules. Android代码贡献者,如果他们不遵守这些规则,那么一般他们的代码不会被接受。
并非所有现存的代码遵循这些规则,但所有的新代码希望能如此
Java 语言规则
我们遵循标准的Java编码约定。
我们还添加一些规则:
- 异常:不要在没有说明的情况下捕捉和忽略它们。
- Exceptions : 不要捕捉一般异常, except in library code at the root of the stack.
- Finalizers :一般不使用它们。
- Imports : 完全符合引入
Java库规则
这里有一些关于使用android Java库与工具的约定。在某些情况下,该约定在一些重要的方式已经发生了变化,老的代码可能在使用过时的模式或库。当使用这些代码,最好继续保持与已存在的风格一致(参见一致性)当创建新的组件从来不使用废弃库。
Java的风格规则
当所有文件都保持一致的风格时,程序就更容易维护。我们遵循标准的Java编码风格,他们由Sun公司为Java编程语言制定的编码约定,除少数例外,和增加一些。这些风格指南是全面而详细的,在Java社区很常用。
此外,我们执行下面的样式规则:
- 注释/Javadoc :使用标准样式写它
- 简短的方法 :不写超大的方法
- 字段(成员变量):要么是在该文件的顶部,或紧接在使用它们的方法前面。
- 局部变量 :限制作用域
- 引入 :android;第三方按字母顺序排列;java(x)
- 缩进排版 :4个空格,没有制表符(tab)
- 行长度 :100个字符
- 字段命名 : 非公有的,非静态字段以m开头,静态变量以s开头 。
- 括号 :开括号不要独占一行
- 注解 :使用标准的注解。
- Acronyms are words : Treat acronyms as words in names, yielding XmlHttpRequest , getUrl() , etc.
- TODO的风格 :“TODO:在这里写描述”
- 一致性 :看看你周围的
- 日志记录 :小心日志记录,它开销很大。
Javatests样式规则
1. 测试方法的命名 :testMethod_specificCase是正确的