写在前面:
不论是哪种语言,规范的编码总能准确描述表达的含义,让人较容易明白,好的代码规范能够省去很多注释,提高同事之间的工作效率。
下面就总结一下我平时用到的代码规范。
先介绍两种命名规则:
驼峰命名法:又称小驼峰命名法。除了首个单词首字母小写除外,其余所有单词所有首字母都要大写。
帕斯卡命名法:又称大驼峰命名法。所有单词首字母大写。
1、包的命名规范
所有单词小写,只能包含a-z字母,或有含义的阿拉伯数字如4代替for,2代替to
建议采用如下规则:【com】.【公司名/组织名】.【项目名称】.【模块名】
常见的包分层结构如下:
com.xxx.xxx.view –> 自定义view 或者是View接口
com.xxx.xxx.activities –> activity类
com.xxx.xxx.fragments –> fragment类
com.xxx.xxx.adapter –> 适配器相关
com.xxx.xxx.utils –> 公共工具类
com.xxx.xxx.bean –> 实体类
com.xxx.xxx.service –> service服务
com.xxx.xxx.broadcast –> 广播接收器
com.xxx.xxx.db –>数据库操作类
com.xxx.xxx.persenter –> 中间对象
com.xxx.xxx.model –> 数据处理类
2、类的命名规范
首字母大写,大驼峰命名法,使用名词。
Activity 类Activity为后缀标识
Adapter类 Adapter 为后缀标识
解析类 Parser为后缀标识
工具方法类 Util或Manager为后缀标识
管理类 Manager为后缀标识
Service类 以Service为后缀标识
Receiver类 以Receiver为后缀标识
ContentProvider 以Provider为后缀标识
自定义基类 以Base开头
自定义view 功能描述 + View
自定义widget 模块名 + 类型(List/Info) + Widget
3、常量命名
所有单词大写,单词间以”_“分隔
4、变量命名
驼峰命名。成员变量以m开头;静态变量以s开头
5、方法命名
与java开发类似,采用驼峰命名规则。首单词首字母小写,其余单词首字母大写。尽量不要使用下划线。
6、资源文件
1)布局文件
Activity——————-activity_
Fragment——————-fragment_
Dialog——————-dialog_
PopupWindow——————-popup_
Menu——————-menu_
Adapter——————-layout_item_
(2)图片
bg_xxx——————-背景图片
btn_xx——————-按钮
ic_xxx——————-单个图标
bg _ 描述 _ 状态——————-控件上的不同状态
btn _ 描述 _ 状态——————-按钮上的不同状态
chx _ 描述 _ 状态——————-选择框,一般2态或4态
(3)anim目录下的命名规范
单词全部小写,单词之间采用下划线分割。
fade_in.xml
fade_out.xml
slide_in_from_left.xml
slide_in_from_top.xml
slide_out_to_right.xml
slide_out_to_bottom.xml
目前收集到的结合平时自己的使用习惯大概就这些,好的命名规范是一项重要的技能,可以在团队合作中可以很大限度减少沟通成本。无规范不成方圆。