《Android APP必须有的东西》之维护篇:命名规范

命名规范要望文知义,简单明了。
命名规范定制太多,就会让人心烦,反而没人遵守了。
---《APP研发录》

命名没有具体的要求,只能说跟上面的要求满足就够了,目前网上能够搜到各种风格的方案,选择一种自己之前没有章法的时候就下意识接近了的,或者自己喜欢的能够快速记住的方案,坚持一两个Demo,大概就能基本记住了。

方案来源于网络,修改添加了部分自己用的习惯。这里整理记录一下本人将默认采用,并且将统一到开发中的方案。

忘了就翻出来瞅瞅!!

命名规范

  • 包命名,单词全部小写

域名反写+项目名称+模块名称,例如:

activity包: cf.paradoxie.demo.activity

实体包: cf.paradoxie.demo.bean

工具包: cf.paradoxie.demo.utils

  • 接口和类命名,单词首字母大写(大驼峰规则)

以下为几种常用类的命名:

公共父类,命名以Base开头,如:BaseActivity, BaseAdapter

activity类,命名以Activity为后缀,如:LoginActivity

fragment类,命名以Fragment为后缀,如:LoginFragment

service类,命名以Service为后缀,如:DownloadService

adapter类,命名以Adapter为后缀,如:MyListAdapter

工具类,命名以Util为后缀,如:StringUtil

接口类,命名以I为前缀(来源于MVP模式),如:IUser

接口实现类,命名以Impl为后缀,如:UserImpl

  • 方法命名,除开第一个单词首字母,其余都大写(小驼峰规则)

以下为几种常用方法的命名:

初始化方法,命名以init开头,例:initView

设置方法,命名以set开头,例:setData

储存方法,命名以save开头,例:saveData

具有返回值的获取方法,命名以get开头,例:getData

通过异步加载数据的方法,命名以load开头,例:loadData

布尔型的判断方法,命名以is或has,或具有逻辑意义的单词如equals,例:isEmpty

  • 常用控件id命名缩写
控件 命名 控件 命名
TextView tv RadioGroup group
EditText et RadioButton rbtn
Button btn ProgressBar progress
ImageView iv CheckBox cb
ImageButton ibtn Spinner spinner
ListView lv ScrollView sv
LinearLayout ll RelativeLayout rl
FramLayout fl TableLayout tl

以上缩写为代表控件的缩写,其id全称需根据配合所在布局及其功能意义而定,缩写_{范围_}意义,例如:

登录按钮:btn_login;

相对布局的tab栏:rl_tab;

标题栏文本:tv_head_title

  • 布局 layout命名

类型_{范围_}功能,范围可选,只在有明确定义的范围内才需要加上。
以下为几种常用的组件类型命名:

activity_{范围_}功能,为Activity的命名格式:activity_login

fragment_{范围_}功能,为Fragment的命名格式

dialog_{范围_}功能,为Dialog的命名格式

header_list_{范围_}功能,为ListView的HeaderView命名格式

footer_list_{范围_}功能,为ListView的FooterView命名格式

  • strings的命名

类型_{范围_}功能,范围可选。
以下为几种常用的命名:

页面标题,命名格式为:title_页面

按钮文字,命名格式为:btn_按钮事件

标签文字,命名格式为:label_标签文字

选项卡文字,命名格式为:tab_选项卡文字

消息框文字,命名格式为:toast_消息

编辑框的提示文字,命名格式为:hint_提示信息

图片的描述文字,命名格式为:desc_图片文字

对话框的文字,命名格式为:dialog_文字

menu的item文字,命名格式为:action_文字

  • colors的命名

前缀{_控件}{_范围}{_后缀},控件、范围、后缀可选,但控件和范围至少要有一个:

背景颜色,添加bg前缀

文本颜色,添加text前缀

分割线颜色,添加div前缀

区分状态时,默认状态的颜色,添加normal后缀

区分状态时,按下时的颜色,添加pressed后缀

区分状态时,选中时的颜色,添加selected后缀

区分状态时,不可用时的颜色,添加disable后缀

  • drawable的命名

跟以上colors的命名类似,此处多了选择器

添加selector后缀(一般为ListView的selector或按钮的selector)

  • 动画文件命名

动画类型_动画方向

fade_in,淡入

fade_out,淡出

push_down_in,从下方推入

push_down_out,从下方推出

slide_in_from_top,从头部滑动进入

zoom_enter,变形进入

shrink_to_middle,中间缩小

  • 变量命名

只能包含字母,单词首字母除第一个外,都为大写,其他字母都为小写

普通变量:mXyxy,或userBean

控件变量,类型为前缀,功能在后面:btnLogin

  • 常量命名

全部大写,采用下划线命名法.例如:MAX_VALUE

注:单词缩写原则:尽量不要用缩写,除非该缩写是约定俗成的

上代码! 这次没有代码!


 注1:单词缩写原则:尽量不要用缩写,除非该缩写是约定俗成的

 注2:方案来源于网络,修改添加了部分自己用的习惯

本文作者:paradoxie
个人主页:谢盒盒的小黑屋,不止说技术
简书地址:简书主页,专注说技术
github地址:paradoxie
转载请注明出处,蟹蟹!
-------我的梦想真的是做一条咸鱼!

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

推荐阅读更多精彩内容