个人整理--安卓开发命名规范

作为一个很重度的强迫症患者,写代码的时候经常会为文件命名纠结一会儿,为了解决这个问题同时也使得项目看起来更加有条例,出BUG的或者找文件的时候不会一团乱麻,在网上找了一些文章,各种Copy自己整理了一下。

先分享这几篇文章:

  1. http://blog.csdn.net/crazy1235/article/details/51346027
  2. http://blog.tinyx.cc/android-naming.html
  3. 阿里技术下载的 Java 开发手册
几种命名法

驼峰命名法:又称小驼峰命名法。除了首个单词首字母小写除外,其余所有单词所有首字母都要大写。
帕斯卡命名法:又称大驼峰命名法。所有单词首字母大写。
下划线命名法:单词与单词间用下划线做间隔。

JAVA In Android

  • 包名 采用反域名命名规则,全部使用小写字母。一级包名为地顶级域名如com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名; 如 com.tinyx.myapp.activities;

  • 类名 用Pascal命名法,尽量避免缩写,如:MyActivity;缩写是众所周知的,如HTML,URL;类名称中包含单词缩写,则单词缩写的每个字母均应大写,如:PublicHTML,CommonURL。

  • 方法名 动词或动名词

  • 初始化相关方法,使用init为前缀标识,如:初始化布局initView();
  • boolean型使用is或check为前缀标识, 如:checkValue()、isValidate();
  • 返回某个值的方法,使用get为前缀标识,如:getName();
  • 数据进行处理相关,尽量使用process为前缀标识,如:processUpdate();
  • 保存数据相关,使用save为前缀标识,如:saveData();
  • 对数据重置的,使用reset前缀标识,如:resetData();
  • 清除数据相关,使用clear前缀标识,如:clearData();
  • 移除某些项目,使用remove前缀标识,如:removeItem();
  • 绘制数据或效果相关的,使用draw前缀标识,如:drawCircle();
  • 变量 采用帕斯卡命名法,建议采用有意义的命名 简单易懂
  • 模型类变量 帕斯卡命名法
  • 非模型类全局参数建议加上小写m开头 (Activity/Fragment 中的变量)
  • 常量 全部大写,采用下划线命名法( MAX_COUNT)
  • 空间变量 建议采用 控件缩写 + 控件逻辑名称 例:btnLogin

资源文件(Res)

遵循一个基本原则 是什么 - 在哪里会被使用 - 用来干什么 - 其他说明

  • drawable

图标类 如:ic_login_logo
图片类(背景图) 如: bg_splash
selector 如:selector_login_btn
状态类 如:bg_login_btn_pressed

  • layout

Activity 和 Fragment 省略
局部布局View文件 如:view_main_header
列表项(list) 如:fragment_user_list_item
自定义对话框 如:dialog_alert

  • anim 在哪里 -- 变化的控件 -- 动画 -- 方向 如:main_button_fade_in

  • menu 通常一个页面不会有多个menu 所以就直接写Activity 或者 Fragmen 名称 如:main_activity / user_fragment

  • values 在哪里 -- 是什么

dimens 下划线命名法 activity_vertical_padding huge_textsize
strings 下划线命名法
styles 下划线命名法
colors 驼峰命名法
attrs 驼峰命名法

控件名称 缩写 控件名称 缩写
TextView tv Button btn
ImageButton img CheckBox cb_sex
RadioButton rbtn EditText et
RadioButton rbtn WebView wv
ToggleButton toggle ProgressBar pb
ScrollView sv ListView/RecyclerView lv

控件的命名
控件命名 : 通常是 控件缩写_ 在哪里_干什么的(语意) 例: tv_main_title\ btn_user_add

控件名称 缩写 控件名称 缩写
TextView tv Button btn
ImageButton img CheckBox cb_sex
RadioButton rbtn EditText et
RadioButton rbtn WebView wv
ToggleButton toggle ProgressBar pb
ScrollView sv ListView/RecyclerView lv

其他补充

  • 使用Strings / dimen / colors / 尽量不要在代码中出现 中文 字体大小 颜色等东西
  • 不要在布局文件中添加点击事件
  • if / for / while / switch / do 等保留字与括号之间要加一个空格
  • 任何二目、三木运算符的左右两边都要加空格
  • 未完待续。。。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容