Android代码的书写规范

毕业工做也有几年了,从开始学习写代码的时候就没有养成好的代码习惯,野路子起家,可是随着工做的深刻,愈加感受,代码的简洁清楚就像是程序员的脸面,写出规范的代码,对我的,对团队都是很是重要的。下面我就简述一下代码的规范。javascript

遵循的格式

使用花括号

if else for do while等语句要和花括号一块儿使用,哪怕只有一句话,也要加上花括号。如:java

if(isTrue)
    true();
else
    false();复制代码

这样的写法就是不正确的,以下的写法才是正确的:程序员

if(isTrue){
    true();
}else{
    false();
}复制代码

列字符限制

根据IDE具体显示的状况分析,为了提升阅读性,通常那一行80-100个字符为宜,超过部分换行布局

switch

switch语句除了应有的首行缩进之外,必定要加上default语句。若是连续两个case之间肯定不要加入break的时候,建议加上//fall through学习

命名约定

类的命名

类的命名遵循大驼峰的命名法MainActivity
大驼峰命名法全部单词的第一个字母大写编码

方法的命名

方法的命名遵循小驼峰的命名法 startActivity。
除了首单词外,其他全部单词的第一个字母大写。spa

package命名

所有使用小写字母。一级包名为com,二级包名为xx(能够是公司或则我的的随便),三级包名根据应用进行命名,四级包名为模块名或层级名。code

接口的命名

命名规则与类同样采用大驼峰命名法,多以able或ible结尾。orm

变量的命名

采用小驼峰命名法。类中控件名称必须与xml布局id保持一致。
做用统一的变量,在结尾加一个量词进行区分更容易搜索和记忆。如
strNameFirst和strNameLastcdn

常量的命名

常量所有大写 如MIN MAX

布局文件的命名

布局文件的命名规则使用“前缀_逻辑名”的方式,单词所有小写:
activity的布局——activity_xxx
fragment的布局——fragment_xxx
自定义控件的布局——view_xxx
对话框的布局——dialog_xxx
列表项的布局——item_xxx

资源文件的命名

资源文件的命名规则使用 前缀模块名逻辑名的方式进行命名,单词所有小写:
按钮以btn为前缀,若是是图片能够是btn_login.png,按钮的点击形态能够是btn_login_normal.xml以及btn_login_pressed.xml
图片的命名以ic为前缀,例如ic_share.png
背景图片能够用bg做为前缀。

注释的规范

/** * Javadoc 常见的标记 * * @param 参数的说明 * @return 返回值的说明 * @throws 异常的描述 * @version 模块的版本号 * @author 模块做者 * @see 参考转向 * @deprecated 标记是否过期 */复制代码

其余编码规范

除了以上的规范,我还从网上找到了一些其余比较重要的注意点,总结以下:
1.java中尽可能不出现中文
2.服务端能够实现的,就不要放在客户端
3.引用第三方库要慎重,避免应用大容量的第三方库,致使客户端包很是大
4.使用静态变量方式实现界面间共享要慎重
5.不要重用父类的handler,对应一个类的handler也不该该让其子类用到,不然会致使message.what冲突
6.activity中在一个View.OnClickListener中处理全部的逻辑
7.若是多个Activity中包含共同的UI处理,那么能够提炼一个CommonActivity,把通用部分叫由它来处理,其余activity只要继承它便可
8.若是所开发的为通用组件,为避免冲突,将drawable/layout/menu/values目录下的文件名增长前缀。
更多的开发知识,能够关注个人公众号:

相关文章
相关标签/搜索