Android代码规范总结

image.png

每当看到github上优秀的项目代码时,那简直就比掏耳朵还享受。写代码如同写文章,代码时开发者的颜值,正所谓没有丑女人,只有懒女人,漂亮的代码也需要我们去精心装饰。简洁规范的代码对个人,对团队,对下一个代码接盘者,是一种责任,也是一种专业的体现。

命名规范:

  • 类的命名:使用大驼峰法,同时需要根据类的作用引入Android相关命名规则,使用类的类型作为前缀或后缀,示例:
    Activity类:xxxActivity
    Fragment类:xxxFragment
    Service类:xxxService
    工具类:xxxUtil
    Adapter类,xxxAdapter
    基类,Basexxx

  • 布局文件命名:
    布局文件命名规则使用“前缀_逻辑名”方式,单词全小写,示例:
    Activity布局文件命名:activity_xxx
    Fragment布局文件命名:fragment_xxx
    自定义控件布局文件命名:view_xxx
    Dialog布局文件命名:dialog_xxx
    列表项布局文件命名:item_xxx

  • 资源文件命名:
    资源文件命名规则使用“前缀模块名功能名”方式,单词全小写,示例:
    我的个人设置textview,用tv_me_setting
    登录按钮,用btn_login
    图标命名以ic为前缀,形如ic_xxx
    背景图片命名以bg为前缀,形如bg_xxx
    背景样式shape形如shape_xxx
    背景选择器selector形如selector_xxx

  • 命名结构

  1. 枚举常量用逗号隔开,换行可选:
public enum NetWorkState {
    WIFI,MOBILE,NONE;
}
  1. 每次只声明一个变量:
    不要组合声明变量,例如int num,max;这样影响阅读。

  2. 数据初始化:可写成块状结构,例如

new int[] {
        0, 1, 2, 3 
}
new int[] {
        0,
        1,
        2,
        3
}
  • 变量和常量
    变量名的命名使用小驼峰法lowerCamelCase。常量名使用大写字母,单词用下划线分割,例如public static final int REQUEST_OK = 200。

  • 临时变量
    变量i,j,k通常用于循环计数;变量m,n通常用于整形;c,d,e通常用于字符型。

  • 常用英文单词缩写:

名称 缩写
icon ic
average avg
background bg
delete del
document doc
error err
increment inc
infomation info
initial init
image img
length len
library lib
message msg
password pwd
position pos
string str
  • 不要使用拼音来命名,不知道英文单词就及时使用翻译。

代码书写规范:

  • 多使用花括号:
    if,else,for等语句和花括号一起使用,即使只有一条语句,也要加上花括号。
if(allowed)
    todo();
else
    back();

不建议这样写,这样可能给人误导。
正确做法应为:

if(allowed){
    todo();
}else{
    back();
}
  • 每行字符个数限制在80—100个之间

  • 空白的使用:符号之间应用一个空格隔开;一段代码内,不要都挤在一起,而应该按照逻辑分组,用空行隔开,使逻辑更加清晰。

  • 修饰符的顺序:类和成员的修饰符如果存在多个,需要按照Java规范的定义排序,顺序如下:
    public protected private abstract static final transient volatile synchronized native

  • 方法的注释:

/**
     * 功能描述
     * @param 参数说明
     * @return 返回值说明
     * @author 模块的作者
     */
private void function(){
}
  • 类的注释:在创建类时标注好作者,创建时间,联系方法,类功能等信息
/**
 * Created by libo on 2017/12/25.
 * email:
 * 单聊
 */

该文章持续总结,持续更新。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,028评论 25 707
  • Android编码规范 源文件基础 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。 文...
    呼呼哥阅读 939评论 0 0
  • 第一部分 打好基础 Laying the Foundation 第一章 欢迎进入软件构建的世界 Welcome t...
    白桦叶阅读 4,623评论 0 17
  • 岁月长河的波浪奔流前行,总会带走一些陈旧的,已被淘汰的旧事物,送来一些适合的,符合时代潮流的新事。这是谁也无法改变...
    补拙莫如勤LV阅读 1,712评论 0 1
  • 天黑后适合看电影。钻在被子里看心绪更是自由。 昨晚看完杀人回忆已过1点。 一个多小时的冷色调里,仿佛小镇里只剩下雨...
    远行灯阅读 303评论 1 0