- 类名 采用大驼峰驼峰命名法,即功能名+类型名的方式来命名类名及方法名
类 | 命名格式 | 示例 |
---|---|---|
Activity | XXX功能+Activity | 如主界面HomeActivity,启动页LauncherActivity |
Service | XXX功能+Service | 如消息推送的Service,PushService或PushMessageService |
BroadcastReceiver | XXX功能+Receiver | 如在线的消息广播接受者,OnlineReceiver |
ContentProvider | XXX功能+Provider | 如联系人的内容提供者,ContactsProvider |
Fragment | XXX功能+Fragment | 如显示联系人的Fragment,ContactsFragment |
Dialog | XXX功能+Dialog | 如普通的选择提示对话框,ChoiceDialog |
Adapter | XXX功能+XX类型控件Adapter | 如联系人列表,ContactsListAdapter |
基础功能类 | Base+XX父类名 | 如BaseActivity,BaseFragment |
工具类 | XXX功能+Utils | 如处理字符串的工具类,StringUtils |
管理类 | XXX功能+Manager | 如管理联系人的类,ContactsManager |
方法名 动词或动名词,采用小驼峰命名法
命名风格 | 含义 |
---|---|
initXX() | 初始化,如初始化所有控件initView() |
isXX() | 是否满足某种要求,如是否为注册用户isRegister() |
processXX() | 对数据做某些处理,可以以process作为前缀 |
displayXX() | 显示提示信息,如displayXXDialog,displayToast,displayXXPopupWindow |
saveXX() | 保存XX数据 |
resetXX() | 重置XX数据 |
addXX()/insertXX() | 添加XX数据 |
deleteXX()/removeXX() | 删除XX数据 |
updateXX() | 更新XX数据 |
searchXX()/findXX()/queryXX() | 查找XX数据 |
draw() | 控件里面使用居多,例如绘制文本drawText |
2. 静态类变量前面加s(static,表示静态变量之意),如,一个静态的单例 sSingleInstance
3. 公有非静态字段命名以p开头
4. 公有静态字段(全局变量)命名以g开头
5.
- 布局文件名称的定义必须为小写字母,否者无法生成R类,尽量不要用缩写。以表达清楚该文件用途为本,通常情况下用下划线连接各语义单词
例如dialog_title_icons.xml 或者list_menu_item_checkbox.xml
-
包命名 采用反域名命名规则,全部使用小写字母 例如:com.beidou.bd601.activity
- 一级包名为com;
- 二级包名为xx(可以是公司或则个人的随便);
- 三级包名应用的英文名app_name;
- 四级包名为模块名或层级名;
-
常量 全部大写,采用下划线命名法.如:MIN_WIDTH,MAX_SIZE
- 布局资源文件 全部小写,采用下划线命名法
布局类型 | 命名风格 |
---|---|
Activity的xml布局 | activity_+XX功能,如主页面activity_home |
Fragment的xml布局 | fragment_+XX功能,如联系人模块fragment_contacts |
Dialog的xml布局 | dialog_+XX功能,如选择日期dialog_select_date |
抽取出来复用的xml布局(include) | include_+XX功能,如底部tab栏include_bottom_tabs |
ListView或者RecyclerView的item xml布局 | XX功能+_list_item,如联系人的contact_info_list_item |
GridView的item xml布局 | XX功能+_grid_item,如相册的album_grid_item |