Android代码规范

框架要求 :

1 . 编码格式统一采用 UTF-8 , 开发工具统一使用 androidstudio . java统一使用 

2 . 目前已采用框架 MVP MVC , 已有的目前不再变化 , 后续统一采用MVP . (除开基本的简单逻辑跳转外)逻辑块尽量都放入impl中 . Activity和Fragment尽量保证只有控件的变动.

3 . 大体框架保持2套左右就行,更换新的框架和技术,例如 rxjava , 布局文件注解获取id 等 , 需其他人同意之后才能在项目中使用 , 自己学习可自行使用Demo练手 .

4 . 会统一使用一个项目基础框架 ( 包括 , 首页[3Item情况] , 工具类 , 无限轮播 , recylerAdapter )  

5 . 统一采用基础包名规范

5.1 adapter -- > 所有adapter放入在内

5.2 base -- > 所有基类 ( 内层再根据所属范围进行分包归纳 )

5.3 bean -- > 所有的实例类 

5.4 mvp -- > 所有mvp相关的接口和实现类

      mvp-presenters -- > 功能类接口 

      mvp-views -- > 布局类接口 ( 包含网络接口 , 因为大部分网络请求需要直接变动UI)

5.5 ui -- > 所有布局类 分为 activity , adapter , fragment 分别放入对应的布局类即可

5.7 constance 常量包名 所有静态常量都放在该包名下

5.7 net 网络请求框架等网络请求的额外需要内容放在该包内

5.8 view -- > 自定义view使用

6 . 用户类一定要复写toString , 将所有参数都归纳在内 .

命名规则:


所有命名不可出现以数字为识别的命名,例如 tv1,tv2,tv3 . Activity1 , Activity2 , Activity3 .

所有常量 和 静态变量 全局变量 一定要进行注释 , 否则交接的人会很多问题 .

类名规则

1 : Activity 命名一律使用 模块名+Activity 的方式。例如,LoginActivity、SignupActivity;


2 : Fragment 命名一律使用 模块名+Fragment 的方式;


3 : 自定义View:Custom( 自定义的意思 )+功能名+View/ViewGroup(具体的组件名称)。例如:CustomImageScroller、CustomLinearLayout、CustomPhotoViewGroup。

4 : adapter命名 : 模块名+功能名+Adapter

例如商品详情页,已购买商品和代付款商品两个List

GoodsBuyAdapter , GoodsPayAdapter .

变量命名规则

4 : Dialog对话框:功能名+Dialog。例如:LoginDialog、WeChatDialog

5 : 每个类的TAG是当前类的类名 , 方便查看日志

对单独需要调试的业务线 ( 可能存在跨类的情况 ) 可以另设一个全局常量TAG进行日志查看 ( 常量需备注 )

6 : 动态广播意图命名  BroadCast + 功能名 . 例如 : 打开广告弹窗意图  BroadCastOpenAd

7 : 全局变量采用m开头+功能名。例如,mTable、mPerson

8 : 所有全局变量 类型一致的 放在一起 , 例如 : 某个类有很多 String的实例 , 则 写成 String mStrlogin , mStrStar , mStrPhone .

9 : 所有布局文件内的控件都跟布局文件的ID一致 , 方便查找 .

资源文件命名 :

10 : 所有控件采用 控件归类+模块名+功能名 . 

例如 , LoginAcitivy 的布局文件 ac_myshop_new 中的控件命名 

tv_myshop_goods , et_mushop_num , img_myshop_banner . 


11 : 布局文件命名 :  ac/fg/adapter + 模块名 + 功能名 ( 如果有多个功能则加上功能名 )

例如 :  ac_main ,  fg_myshop , adapter_myshop_old , adapter_myshop_new

对于头布局和底布局这种特殊情况  footer/header + 模块名 + 功能名

例如 : 首页产品列表( MainActivity ) 需要一个头布局 , header_main_ac_goodslist


12 : 色值命名 : ( 所有的色值都必须写在资源文件中 , 不能在布局文件中写死 )

主题色 : theme_color

所有页面背景色 : background_color

所有分割线颜色 : dividerline_color

剩余其他色值 统一按照 color+色值 命名 .  例如 : #555555 命名为 color_555555

13 : drawable 命名  :

普通图片 : img + 模块名 + 功能名 . 例如 登录页的手机图片 img_ac_login_photo 

selector : selector  + 模块名 + 功能名 . 例如 selsctor_ac_login_button

Shape : shape +solid + storke + conner

例如 #d5d2d2 色值 边角5度的全填充shape可以命名为  shape_ d5d2d2_ d5d2d2_5

例如 #d5d2d2 色值 边角5度的透明充shape可以命名为  shape_ null_ d5d2d2_5


14 : 图片资源命名

img + 模块名 + 功能名 . 例如 登录页的手机图片 img_login_photo

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,857评论 25 707
  • 1.源代码格式规范 1.1 Java文件样式 1.1.1版权信息 版权信息必须在 java 文件的开头,比如: /...
    吉瑞蜀黍阅读 594评论 0 1
  • ----------------------Java规范---------------------- 源文件结构 ...
    pphdsny阅读 315评论 0 0
  • 周五下班,先生说:小明辞职了。(这个小明是我侄儿) 我说,一点不奇怪,靴子终于落了地。我早知道...
    苏州的蔷薇花开阅读 802评论 7 0
  • 依稀还记得许巍歌里唱到,曾梦想仗剑走天涯,看一看世间的繁华。现在的我也想像歌里唱到的那样乘着清风,游荡在世间的...
    造梦安提阅读 853评论 0 0