现有 App 规范

1.编码格式

源文件编码格式为 UTF-8。

2.列字符个数限制

a.80个字符的列限制,除了下述例外,任何一行如果超过这个字符数限制,必须自动换行。

b.不可能满足列限制的行(例如,Javadoc中的一个长URL,或是一个长的JSNI方法参考)。

c.package和import语句

3.包名统一用小写

公司所有项目必须以(com.jumper)为包名前缀

如:com.jumper.hospitaldoctor

4.类名

类名都以UpperCamelCase风格编写。采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的,比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写


Activity 类                Activity为后缀标识

如:欢迎页面类WelcomeActivity

Adapter类                Adapter 为后缀标识

如:新闻详情适配器 NewDetailAdapter

工具方法类                Util或Manager为后缀标识

如:(与系统或第三方的Utils区分)或功能+Util线程池管理类:ThreadPoolManager

日志工具类:LogUtil(Logger也可)

打印工具类:PrinterUtil

数据库类                  DBHelper后缀标识

如:新闻数据库:NewDBHelper

Service类                Service为后缀标识

如:时间服务TimeServiceBroadcast

Receiver类              Receiver为后缀标识

如:推送接收JPushReceiver

ContentProvider    Provider为后缀标识


自定义的共享基础类        Base开头

如:BaseActivity,BaseFragment


5.常量名

全部字母大写,用下划线分隔单词。

如:public static final int DEFAULT_TIME_OUT = 1000;

6.非常量字段名

a.非公有,非静态字段命名以m开头。

如:private Context mContext;

int mClickPosition;

b.静态字段命名以s开头。

如:private static boolean sIsActivite;

c.公有静态字段(全局变量)命名以g开头

如:public static UserInfo gUserInfo;

d.其它Type 类型

字符串添加如下后缀:Str

集合添加如下后缀:List、Map、Set

数组添加如下后缀:Arr

如:

String mPhoneStr;

private List mFHRDataList;


7.方法名

方法名都以 LowerCamelCase 风格编写。

方法名通常是动词或动词短语。

initXX()                           初始化相关方法,使用init为前缀标识,如初始化布局initView()


isXX() checkXX()             方法返回值为boolean型的请使用is或check为前缀标识


getXX()                           返回某个值的方法,使用get为前缀标识


handleXX()                     对数据进行处理的方法,尽量使用handle为前缀标识


displayXX()/showXX()    弹出提示框和提示信息,使用display/show为前缀标识


saveXX()                         与保存数据相关的,使用save为前缀标识


resetXX()                        对数据重组的,使用reset前缀标识


clearXX()                        清除数据相关的


removeXXX()                  清除数据相关的


drawXXX()                      绘制数据或效果相关的,使用draw前缀标识


另:

@Override:能用则用

只要是合法的,就把@Override注解给用上。


8.资源文件命名规范

a.资源布局文件(XML文件(layout布局文件)):


全部小写,采用下划线命名法

  1) contentview 命名

      必须以全部单词小写,单词间以下划线分割,使用名词或名词词组。

      所有Activity或Fragment的contentView必须与其类名对应,对应规则为:

      将所有字母都转为小写,将类型和功能调换(也就是后缀变前缀)。

     例如:activity_main.xml

  2) Dialog命名:dialog_描述.xml

     例如:dialog_hint.xml

  3) PopupWindow命名:ppw_描述.xml

     例如:ppw_info.xml

  4) 列表项命名:item_描述.xml

     例如:item_city.xml

b.values中name命名


stringscolors 的name命名使用下划线命名法,采用以下规则: 

模块名+activity/fragment/item+逻辑名称

如:health_activity_main_title 健康主页标题 

styles的name命名使用 Camel命名法,采用以下规则:

通用的      类别.属性.属性

如:textview.size_16.color_666666

非通用的      模块名+逻辑名称

如:main_timeDialog

9.UI控件缩写表


LinearLayout                        ll         llFriend

RelativeLayout                     rl         rlMessage

FrameLayout                        fl         flCart

Button                                 btn       btnHome

ImageButton                       ibtn       btnPlay

TextView                             tv         tvName

EditText                               et        etName

ListView                               lv          lvCart

ImageView                           iv          ivHead

GridView                              gv         gvPhoto


10.常见的英文单词缩写:

名称缩写

icon                           ic (主要用在app的图标)

color                          cl(主要用于颜色值)

divider                        di(主要用于分隔线,不仅包括Listview中的divider,还包括普通布局中                                    的线)

average                     avg

background               bg(主要用于布局和子布局的背景)

buffer                        buf

control                      ctrl

delete                        del

document                  doc

error                          err

escape                       esc

increment                  inc

infomation                 info

initial                         init

image                         img

Internationalization    I18N

length                        len

library                        lib

message                    msg

password                   pwd

position                     pos

server                        srv

string                        str

temp                         tmp

window                     wnd(win)


摘自://www.greatytc.com/p/0a984f999592

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

推荐阅读更多精彩内容

  • 文章来自https://github.com/Blankj/AndroidStandardDevelop#安卓开发...
    小庄bb阅读 753评论 0 1
  • 参考资料 1)、https://github.com/ribot/android-guidelines 1、IDE...
    柠檬不萌只是酸9阅读 589评论 0 1
  • Android编码规范 源文件基础 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。 文...
    呼呼哥阅读 936评论 0 0
  • Android 编码规范 1. 前言 这份文档是 Google Java Code Style 的译文,并稍有添加...
    人失忆阅读 445评论 0 3
  • 开发规范 首先,我这篇开发规范,只是针对于刚进入职场的萌新来写的,已经形成自己开发风格的可以自行绕过。其次,这些也...
    手术刀切西瓜阅读 846评论 0 6