Android 编程规范

Android 编程规范

本编程规范参考Code Style Guidelines for Contributors整理，如有错误，欢迎完善。

一 注释规范

1.      类、接口注释的内容

1、用途。开发人员使用某个类/接口之前，需要知道采用该类/接口的用途

2、开发维护的日志。一个有关于该类/接口的维护记录：时间、作者、摘要。

Eclipse 代码格式化：

位置：

Window ? Preferences ? Java ? Code Style>Code Template >Code>

New Java files

内容：

${filecomment}

${package_declaration}

/**

 * 类说明：  

 * @author  Liucd

 * @date    ${date}

 * @version 1.0

 */

${typecomment}

${type_declaration}

2.     方法注释的内容

1、该方法是做什么的 。

2、传入什么样的参数给这个方法。@param
3、异常处理。@throws
4、这个方法返回什么。@return

二 命名规范

命名规范的目的是使程序更易读。它们也可以提供一些有关标识符功能的信息，以助于理解代码，不论它是一个常量、包、还是类。

      应该尽量做到以下几点：使用完整的英文描述来命名；避免命名超长（15 个字符以内比较好）；避免相似的命名，例如：persistentObj 和persistentObjs 不要一起使用；anSqlStmt 和anSQLStmt 不要一起使用；慎用缩写，如果要用到缩写，则按照缩写规则使用缩写，例如：No.代表number 数字，ID.代表identification标示。下面分类介绍命名规范。

1.      包

包名小写

import com.founder.mobile.common

 

2.     类/接口

大小写字母混合组成，头字母大写，名字要有意义。

class XmlParseUtils

 

3.     方法

方法名字是一个动词，大小写字母混合组成，第一个单词的首字母小写，其后单词的首字母大写，名字要有意义。

run();

getBackground();

 

4.     变量、参数 

变量用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。

变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m 和n，它们一般用于整型；c，d，e，它们一般用于字符型。

 

5.     集合、数组

应该从命名中体现其复数的含义，例如加后缀s或前缀some，名字要有意义。

customers;
postedMessages;
someCustomers;
someItems ;

 

6.     域(Field)命名

非公有，非静态字段命名以m开头。 
静态域命名以s开头。
其他字段以小写字母开头。
public static final 字段(常量) 全部大写，并用下划线连起来。

例子：

1.  public class MyClass 

2.  {  

3.      public static final int SOME_CONSTANT = 42;  

4.      public int publicField;  

5.      private static MyClass sSingleton;  

6.      int mPackagePrivate;  

7.      private int mPrivate;  

8.      protected int mProtected;  

9.  }

7.     文件命名规范

res/layout目录下文件：

统一用小写和下划线"_"组合命名，建议xml文件加个前缀以便区分，如对话框的xml配置文件:dlg_name.xml；

res/drawable目录下文件：

统一用小写加下划线“_”组合命名，同上，每个资源文件最好加个前缀以便区分，如：btn_submit_default.png，btn_ submit _pressed.png，btn_ submit.xml;

 

 

三 样式规范

1.       注释/Javadoc ：使用标准样式写它

2.      简短的方法 ：不写超大的方法，如果一个方法超过一屏，则考虑重构。

3.      字段(成员变量)：要么是在该文件的顶部，或紧接在使用它们的方法前面。

4.      局部变量 ：限制作用域

5.      行长度 ：一行的最大长度是一屏。

6.      一致性 ：保证代码规范的一致性。

7.      在定义类时，应该按照访问权限的大小分别排列属性和方法。

1、public
2、protected
3、包级别(没有访问修饰符的，默认为friendly)
4、private

8.     单位使用规范。

在使用单位时，如果没有特殊情况，一律采用dip和sp（字体大小单位）这两个单位。因为这两个单位是与设备分辨率无关的，能够解决在不同分辨率的设备上显示效果不同的问题。

 

 

附录：

Google Code Style Guidelines for Contributors  http://source./source/code-style.html