在开发中,遵循良好的编码规范,不仅仅可以提高代码的可读性,减小出错的可能性,同时也降低与其他开发者交流的成本,易于他人的维护与协作。 本文简单总结了Android开发中的一些代码规范,供开发者参考。
基本要求
① 除了注释,代码中不出现中文
② 每个类写上必要的注释,类的说明,作者,联系方式
③ 方法加上必要的注释说明,方便以后维护
包管理
(1)base:存放基础类的包,里面的类以Base为前缀,例如BaseActivity;
(2)activity:存放activity的包,每个activity命名以Activity结尾,例如MainActivity;
(3)fragment:存放fragment的包,每个fragment命名以Fragment结尾,例如ChatFragment;
(4)receiver:存放receiver的包;
(5)service:存放service的包;
(6)adapter:存放adapter的包,每个adapter命名以Adapter结尾,例如EventItemAdapter;
(7)common:存放一些公共常量,例如后端接口、SharedPreferenceKey、IntentExtra等;
(8)utils:存放工具类的包,比如常见的工具类:LogUtils、DateUtils;
(9)entity:存放实体类的包;
(10)widget:存放自定义View的包;
以上是一些常见的包,但不局限于此,视项目的具体情况而定。
文件的命名
类的命名
命名应该遵循驼峰命名法
对于继承自Android组件的类来说,命名是应以改组件的名称结尾;列如:SingInActivity, SingInFragment , ImageUploaderService,ChangePasswordDialog .
Res中文件的命名
资源文件应该以小写+下划线(_)的格式命名。
图片文件
以下是对于图片文件的命名习惯
对于图标的命名习惯
对于选择器状态的命名习惯
布局文件
布局文件应该和将要用于的 Android 组件的名称相匹配,但是这次应以组件的名称开头。例如, 如果我们为 SignInActivity,创建布局文件,那布局文件的名称就应该为 activity_sign_in.xml.
一个特殊的情况就是在为 Adapter 中的子项创建布局的时候, 例如, 显示 ListView 中的内容。在这种情况下,布局文件的前缀应该为 item_
应该注意到还有一个特殊情况的存在,那就是在创建一个布局中的其中一小块布局时,在这种情况下就应该使用前缀 partial_ 。
menu 文件
与布局文件的命名的规则相似,menu 文件也应该和将要用于的 Android 组件的名称相匹配。例如,当我们在为 UserActivity 创建 menu 文件时,那 menu 文件的名称就应该是 activity_user.xml
命名规则是不把单词 menu 作为名称的一部分,因为这些文件已经存放在 menu 的文件下了。
资源文件
在 values 文件夹中的资源文件在命名时应该为复数。例如, strings.xml, styles.xml, colors.xml, dimens.xml, attrs.xml