Android 代码风格指南(转)
http://blog.lytsing.org/archives/39.html
Android的代码风格规则
The rules below are not guidelines or recommendations, but strict rules. Android代码贡献者,如果他们不遵守这些规则,那么一般他们的代码不会被接受。
并非所有现存的代码遵循这些规则,但所有的新代码希望能如此
Java 语言规则
我们遵循标准的Java编码约定。
我们还添加一些规则:
1.异常:不要在没有说明的情况下捕捉和忽略它们。
2.Exceptions : 不要捕捉一般异常, except in library code at the root of the stack.
3.Finalizers :一般不使用它们。
4.Imports : 完全符合引入
Java库规则
这里有一些关于使用android Java库与工具的约定。在某些情况下,该约定在一些重要的方式已经发生了变化,老的代码可能在使用过时的模式或库。当使用这些代码,最好继续保持与已存在的风格一致(参见一致性)当创建新的组件从来不使用废弃库。
Java的风格规则
当所有文件都保持一致的风格时,程序就更容易维护。我们遵循标准的Java编码风格,他们由Sun公司为Java编程语言制定的编码约定,除少数例外,和增加一些。这些风格指南是全面而详细的,在Java社区很常用。
此外,我们执行下面的样式规则:
1.注释/Javadoc :使用标准样式写它
2.简短的方法 :不写超大的方法
3.字段(成员变量):要么是在该文件的顶部,或紧接在使用它们的方法前面。
4.局部变量 :限制作用域
5.引入 :android;第三方按字母顺序排列;java(x)
6.缩进排版 :4个空格,没有制表符(tab)
7.行长度 :100个字符
8.字段命名 : 非公有的,非静态字段以m开头,静态变量以s开头 。
9.括号 :开括号不要独占一行
10.注解 :使用标准的注解。
11.Acronyms are words : Treat acronyms as words in names, yielding XmlHttpRequest , getUrl() , etc.
12.TODO的风格 :“TODO:在这里写描述”
13.一致性 :看看你周围的
14.日志记录 :小心日志记录,它开销很大。
Javatests样式规则
1. 测试方法的命名 :testMethod_specificCase是正确的
--------------------------------------------
Java语言规则
异常:不要忽视
有时很容易编写完全忽略异常的代码,比如:
异常: 不要捕捉一般异常
有时候人们容易为了偷懒,在捕捉异常时会这样做:
--------------------------------------------
简短的方法
这在一定程度上是可行的,方法应该保持小而直观的反应它的功能。然而得承认,长的方法有时是比较适当的,因此没有死限制放在方法的长度。如果一个方法超过40行,想想是否可以在没有危害程序结构上进行拆分。
--------------------------------------------
局部变量
局部变量的作用范围应保持最小( Effective Java Item 29)。这样,增加代码的可读性和可维护性,降低错误的可能性。
每个变量应该在最里面的代码块声明,括入变量的所有使用。 局部变量应该先声明后使用,尽量在声明局部变量的同时初始化。如果你还没有足够的信息来初始化变量,你应该推迟声明,直到你需要声明它的时候。
Loop variables should be declared in the for statement itself unless there is a compelling reason to do otherwise:
循环变量应该for里面声明,除非有令人信服的理由不这样做:
if (condition) body; // 槽糕
行长度
每一行代码中的文本应在最多100个字符。
There has been lots of discussion about this rule and the decision remains that 100 characters is the maximum.
例外:如果一个注释行包含一个示例命令或文字网址超过100个字符,该行可能会超过100个字符,方便于剪切与粘贴。
例外:import 行可以超过这个限制,因为人们很少见到他们.这也简化了书写工具。
Java 1.5的注解
Eclipse 代码格式化
你可以导入development/ide/eclipse下的文件,使得Eclipse按照Android代码风格规则。选择 “Window ? Preferences ? Java ? Code Style,使用 “Formatter ? Import” ,导入android-formatting.xml,”Organize Imports ? Import” 导入 android.importorder.
eclipse tab 设置为4个空格:
Preferences -> General -> Editors -> Text Editors:
Insert spaces for tabs
If you enjoyed this post, make sure you subscribe to my RSS feed!