Android 开发规范(二)

命名规范

1. 包命名

域名反写+项目名称+模块名称,全部单词用小写字母。 例如,公司业主项目的Model模块包名如下:
com.yupeng.owner.contruction

2. 类和接口命名

使用大驼峰规则,用名词或名词词组命名,每个单词的首字母大写。如果一个类的类名由多个单词组成,所有单词的首字母必须大写,单词尽量写全称,不要简写,除非约定俗成的名字,例如:URL,RTMP,RTSP 这些广泛使用的专有名词,可以全部大写,也可以首字母大写。
以下为几种常用类的命名:

  • activity类,命名以Activity为后缀,如:LoginActivity
  • fragment类,命名以Fragment为后缀,如:ShareDialogFragment
  • service类,命名以Service为后缀,如:DownloadService
  • adapter类,命名以Adapter为后缀,如:ConstructionAdapter
  • handler类,命名以handler为后缀,如:descriptionHandler
  • List<T>类,命名以List为后缀,如:descriptionList
  • 工具类,命名以Util为后缀,如:EncryptUtil
  • 模型类,命名以Model为后缀,如:CityModel
  • 接口实现类,命名以Impl为后缀,如:ApiImpl
3. 方法命名

使用小驼峰规则,用动词命名,第一个单词的首字母小写,其他单词的首字母大写。 以下为几种常用方法的命名:

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

  • 按钮点击方法,命名以to开头,例:toLogin

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

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

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

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

4. 控件缩写
image.png
5. 常量命名

全部为大写单词,单词之间用下划线分开。

public final static in PAGE_SIZE  =  20;
6. 变量命名

类型描述+{范围描述+}意义描述+的组合,用驼峰式,首字母小写。

变量名不建议使用下划线分隔单词,Android 的系统类都采用此方法。

private TextView txtHeaderTitleTxt;  // 标题栏的标题

private Button btnLogin;  // 登录按钮

7. 控件id命名

控件缩写{范围}意义,范围可选,只在有明确定义的范围内才需要加上。

建议:xml 布局文件中的控件的id的命令与*.java的代码文件中的空间对象的命名保持一致。

<!-- 这是标题栏的标题 -->
<TextView
android:id="@+id/txt_header_title"/>

<!-- 这是登录按钮 -->
<Button android:id="@+id/btn_login" />

8. layout命名

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

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

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

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

  • item_list_{范围_}功能,为ListView的item命名格式

  • item_grid_{范围_}功能,为GridView的item命名格式

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

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

9. 关于字面常量

代码中不允许出现直接硬编码的字面常量,如果是控件上显示的文本,必须放在string.xml资源文件中。如果是代码中用到的常量字符串,必须定义成public static final String类型的常量值,在代码中使用该定义的常量值。

这样做的好处是以后需要修改该常量值,只需要修改一个地方。如果是硬编码在代码中则需要修改所有使用它的地方,而且拷贝容易出错。

Activity之间传递参数的时候,intent.putExtrakey``值也要符合命名规范,并且统一定义为静态常量,不能直接硬编码在代码中,否则想要修改的时候非常麻烦。某一个Activity在被启动的时候需要接受参数,那么这些参数的key定义就应该放在该Activity中。

10. strings的命名

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

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

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

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

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

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

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

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

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

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

11. colors的命名

颜色值的命名:color_descriptioncolor为前缀,全部小写,下划线分割前缀{控件}{范围}{_后缀},控件、范围、后缀可选,但控件和范围至少要有一个。

  • 背景颜色,添加bg前缀

  • 文本颜色,添加text前缀

  • 分割线颜色,添加div前缀

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

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

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

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

  • description既可以是该颜色使用的功能描述,也可以是该颜色的英文描述,也可以是具体的颜色值,例如:

<color name="color_white">#ffffff</color>
<color name="color_text_white">#ffffff</color>
<color name="color_grey_ccc">#cccccc</color>
<color name="color_grey_ddd">#dddddd</color>
12. drawable的命名

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

  • 图标类,添加ic前缀

  • 背景类,添加bg前缀

  • 分隔类,添加div前缀

  • 默认类,添加def前缀

  • 区分状态时,默认状态,添加normal后缀

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

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

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

  • 多种状态的,添加selector后缀(一般为ListView的selector或按钮的selector)

13. 动画文件命名

动画类型_动画方向。

  • fade_in,淡入

  • fade_out,淡出

  • push_down_in,从下方推入

  • push_down_out,从下方推出

  • slide_in_from_top,从头部滑动进入

  • zoom_enter,变形进入

  • shrink_to_middle,中间缩小

注释规范

1. 类和接口注释

文件顶部统一添加版权声明,声明的格式如下:
点击菜单栏的“File“->“Settings”,打开Settings窗口。
点击“Editor”下面的“File and Code Templates”,然后选中Templates里面的Class。

image.png

然后选中Includes tab下面的File Header。


image.png
/**
 * Created by ${USER} on ${DATE}.
 * 类的功能及描述
 */
2. 方法注释

下面几种方法,都必须添加javadoc注释,说明该方法的用途和参数说明,以及返回值的说明。

  • 接口中定义的所有方法

  • 抽象类中自定义的抽象方法

  • 抽象父类的自定义公用方法

  • 工具类的公用方法

/**
* 登录
*
* @param loginName 登录名
* @param password  密码
* @param listener  回调监听器
*/
public void login(String loginName, String password, ActionCallbackListener<Void> listener);
3. 变量和常量注释

下面几种情况下的常量和变量,都要添加注释说明,优先采用右侧//来注释,若注释说明太长则在上方添加注释。

  • 接口中定义的所有常量

  • 公有类的公有常量

  • 枚举类定义的所有枚举常量

  • 实体类的所有属性变量

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

推荐阅读更多精彩内容