Android代码的书写规范

毕业工作也有几年了,从开始学习写代码的时候就没有养成好的代码习惯,野路子起家,但是随着工作的深入,越发感觉,代码的简洁清楚就像是程序员的脸面,写出规范的代码,对个人,对团队都是非常重要的。下面我就简述一下代码的规范。

遵循的格式

使用花括号

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

if(isTrue)
    true();
else
    false();

这样的写法就是不正确的,如下的写法才是正确的:

if(isTrue){
    true();
}else{
    false();
}

列字符限制

根据IDE具体显示的情况分析,为了提高阅读性,一般那一行80-100个字符为宜,超过部分换行

switch

switch语句除了应有的首行缩进以外,一定要加上default语句。如果连续两个case之间确定不要加入break的时候,建议加上//fall through

命名约定

类的命名

类的命名遵循大驼峰的命名法MainActivity
大驼峰命名法所有单词的第一个字母大写

方法的命名

方法的命名遵循小驼峰的命名法 startActivity。
除了首单词外,其余所有单词的第一个字母大写。

package命名

全部使用小写字母。一级包名为com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名。

接口的命名

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

变量的命名

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

常量的命名

常量全部大写 如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目录下的文件名增加前缀。
更多的开发知识,可以关注我的公众号:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,372评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,368评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,415评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,157评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,171评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,125评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,028评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,887评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,310评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,533评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,690评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,411评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,004评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,812评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,693评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,577评论 2 353

推荐阅读更多精彩内容