大智慧Android代码规范.doc

Android代码规范 编写 马祥力 审核 马祥力 格式审核 马祥力 创建时间 2013-12-06 最新修改时间 2013-12-06 修改日志 修改日期 修改人 修改内容 2013-12-06 马祥力 初稿 1.文件名 (1) 文件名 Public类名要根据编译程序的规则，必须是和文件名相同(包含大写小写的区別)． (2) 类名开头大写．类名中多个单词的，每个单词首写字母大写 CapitalizedWithInternalWordsAlsoCapitalized (3) 异常类名 将最后作为了Exception 的类名． ClassNameEndsWithException (4) 常数(static final) 将大写用“_” 连接的． UPPER_CASE_WITH_UNDERSCORES (5) 自定义控件名 格式：Newtouch + 功能名 + 继承父类名，若继承自容器类，统一使用View 示例：NewtouchTitleView、NewtouchColorFilterButton、NewtouchPullListView (6) 辅助功能类名 格式：功能名+ Util 示例：AnimationUtil 2.方法名 (1) 方法名 最开始是小写，后面隔开用大写(驼峰命名法)，方法名一般是动词，或者是动词+名词， 尽量不要太长，较长的话略去名词中的元音字母或容易看懂的简写形式。 例如changeInfomation()可简写为changeInfo() 参数名-同方法名命名规则；在参数名为一个单词的情况下，必需尽可能的明确其含义； 注释-公开的接口方法，需要以javadoc格式（/** …… */），添加说明； 例： setTitleBtnView(View view, float width, float height) (2) Factory方法(new Object的) X newX() X createX() (3) 属性的取得方法 X x() 在X getX() // JavaBeans 可以作为Proverty来用(推荐) 在boolean isEnabled() // JavaBeans 可以作为Proverty(标准)来用(推荐) (4) 属性的设定方法 在void setX(X value) // JavaBeans 可以作为Proverty（标准）来用(推荐) (5) 返回boolean 变量的方法 is + 形容词，can + 动詞，has + 过去分词，三单元动词，三单元动词+ 名词． boolean isEmpty() // JavaBeans 可以作为Proverty（标准）来用(推荐) boolean empty() // 不行！因为能取’空’的动词的意思,所以不好． boolean canGet() boolean hasChanged() boolean contains(Object) boolean containsKey(Key) 理由: if, while 文等的条件会变为容易读．还有true 是哪个意思容易懂． (6) getInstance() 单实例类获得实例的方法建议用此方法名 (7) 无意义的名字 叫做Info, Data, Temp, Str, Buf 的名字要再考虑． 坏例子: double temp = Math.sqrt(b*b - 4*a*c); 好例子: double determinant = Math.sqrt(b*b - 4*a*c); (8) 大写小写 大写和小写被作为其他的文字来用，但不能取仅用此区別的名字． 3.变量名 (1)非公有的，非静态字段以m开头，静态变量以s开头 。 其他字段以小写字母开头。 public static final 字段(常量) 全部大写，并用下划线连起来。 public class MyClass { public static final int SOME_CONSTANT = 42; public int publicField; private static MyClass sSingleton; int mPackagePrivate; private int mPrivate; protected int mProtected; } 不建议使用匈牙利命名法，即在变量前后或加上类型标识，在java中并无太大意义。 4.Android资源文件名 a) layout 命名 普通- item_ + 业务名 item_customer_detail.xml ActivityGroup - group_ + 业务名 group_main.xml