Android命名规范

一、命名规范

1、 包

采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名xxx(为个人或公司名称,可以简写),三级包名根据应用进行命名,四级包名utils或service等(模块名或层级名),根据实际情况也是可以用五级包名,六级包名。

        utils

         此包中包含:公共工具方法类,比如:LogUtil、TimeUitl、FileUtil等

        adapter

         此包中包含一些适配器的类,比如:CardAdapter、FloatWindowAdapter等

        base

         此包中包含:一些共同类的基类,比如:BaseActivity(所有的Activity类都继承这个类)、BaseFragment(所有的Fragment都继承这个类)

        bean

         此包中包含:一些属性对象类,比如:StudentBean、UserBean等

        config

         此包中包含:最顶级的配置类,比如:MyApplication(继承了Application)

        httpservice

         此包中包含:Http数据的请求接口类,如:ILogin接口,IRegister,IUpdate等

        interface

         此包中包含:某个页面或对象的所用操作接口类,这个接口主要是定义这个对象的所有方法。如:IUser接口,IArticle接口,ITopic接口等

        model

         这是MVC或MVP框架设计中的M。此包中包含:某个页面或对象的所用操作类,这个类继承了上面定义的interface接口,重写并实现方法。如:UserModel,lLoginMode类

        view

        此包中包含:activity包。如MainActivity,HomeActivity. 

                                fragment包。但是Fragment一般都是多个存在的,所以fragment包下一般还有六级包名,表示里面是哪个页面的Fragment对象。

        weight

         此包中包含:自定义View或自定义对话框等视图类。如:CursroDialog类,ScrollListView类等

        db

         此包中包含:数据库操作类

        service

         此包中包含:Service服务类

        broadcast

         此包中包含:Broadcast广播接收者类

        provider

         此包中包含:Provider内容提供者类


2、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。

如:public class MyFirstClass{}


3、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。

如:int index=0;

       public void toString(){}

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

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


4、 常量名全部大写

private static final String DEFAULT_VALUE = null;


6、所有命名规则必须遵循以下规则:

    1)、名称只能由字母、数字、下划线、$符号组成

    2)、不能以数字开头

    3)、名称不能使用JAVA中的关键字。

    4)、坚决不允许出现中文及拼音命名。

    5)、程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。


下面为常见的英文单词缩写:

名称缩写

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

color  cl(主要用于颜色值)

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

selector    sl(主要用于某一view多种状态,不仅包括Listview中的selector,还包括按钮的selector)sel_ok 选择图标使用sel_功能_说明

average    avg

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

                    bg_head 背景图片使用bg_功能_说明

buffer    buf

control    ctrl

delete    del

document doc

dialog        dlg_hint.xml

error    err

escape    esc

increment    inc

infomation   info

initial init

image    img

Internationalization    I18N

length    len

library    lib

message    msg

password    pwd

position    pos

popupWindow    ppw_info.xml

server    srv

string    str

temp    tmp

window    wnd(win)

button    btn_xx 

                btn_xx_normal 按钮图片使用btn_正常情况效果

                btn_xx_press 按钮图片使用btn_点击时候效果

LayoutView    lv

RelativeView    rv

TextView    tv

Button    btn

ImageButton        imgBtn

ImageView         imgView 或 iv

EditText           edtTxt

Tab                tab

Spinner            spn

Chronometer        cmt

ScollView          sclVi

TextSwitch         txtSwt

ImageSwitch        imgSwt

listView           lVi 或则lv

ExpandableList     epdLt

MapView            mapVi


二、注释规范

1、类注释

在每个类前面必须加上类注释,注释模板如下:

/**

* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

* FileName: Test.java

* 类的详细说明

*

* @author 类创建者姓名

* @Date    创建日期

* @version 1.00

*/


2、属性注释

在每个属性前面必须加上属性注释,注释模板如下:

/** 提示信息 */

private String strMsg = null;


3、方法注释

在每个方法前面必须加上方法注释,注释模板如下:

/**

* 类方法的详细使用说明

*

* @param 参数1 参数1的使用说明

* @return 返回结果的说明

* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

4、构造方法注释

在每个构造方法前面必须加上注释,注释模板如下:

/**

* 构造方法的详细使用说明

*

* @param 参数1 参数1的使用说明

* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/


5、方法内部注释

在方法内部使用单行或者多行注释,该注释根据实际情况添加。

如://背景颜色

       Color bgColor = Color.RED

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,070评论 25 707
  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 12,712评论 2 59
  • android文件众多,根据名称来辨别用途很重要,因此命名要规范 这篇文章可参考:Android 命名规范 (提高...
    Near尼尔阅读 471评论 0 2
  • 命名规范 1. 包命名 规则:包名全部小写,采用反域名命名规则,一级包名是顶级域名,通常为com, edu, go...
    聂顺阅读 844评论 0 2
  • 1.Xcode 8 VVDocumenter替代集成有标准注释模板,使用快捷键是: command + optio...
    sunmumu1222阅读 1,014评论 0 0