Android APP开发命名规范
编辑人
安前松
编辑日期
2016年7月23日
版本
V1.0.0
声明
在此次开发过程中需要严格遵守命名规则，如果有违背此命名规范命名的迹象，则自己承担相应的责任，此文档未经批准，严禁擅自修改。
出发点
①、为了有效，快速研发
②、为了团队一致性，在后面bug修改时便于查找
③、增加代码可读性
④、实现后期可维护性
命名规范
| Java |
严格准守驼峰式命名 ①包名一律为小写字母，并且要见名知义，如：com.android.activity ②类名必须以大写字母开头，后面每个单词进行驼峰式命名，并且要见名知义。如：MainActivity |
||||||||||||||||||||
| 包名 |
一级包名为com，二级包名为android，三级包名为工程名称（如：TaoBao），四级包名根据某一类class的集合来命名（如：activity,adapter,fragment等），五级以后包名根据自己需求，要见名知义。 |
||||||||||||||||||||
| 类 |
要见名知义 ①Activity：以Activity结尾，如果当前页面是店铺页面，参考命名为ShopActivity ②Fragment：以Fragment结尾，如果当前页面为店铺页面，参考命名为ShopFragment ③BroadCastReceiver：以Receiver结尾，如果当前广播为网络广播，参考命名为NetReceiver ④Service：以Service结尾，如果当前有一个音乐Service，参考命名为MusicService ⑤自定义View：以X开头，如XListView ⑥Adapter：以adapter结尾，如店铺页面的适配器，参考命名为ShopAdapter ⑦工具类：以Utils或者Manager或者Helper结尾，比如网络工具类参考命名为NetUtils/NetManager/NetHelper ⑧常量类：以Constant结尾，如URL常量，参考命名为URLConstant ⑨Interface:以I开头，如IHome ⑩枚举：以E开头，如EStatus 其他： Ⅰ实体类:以Entity结尾或者M开头，比如学生实体类，参考命名为StudentEntity/MStudent Ⅱ：抽象类:以A开头，比如学生抽象类，参考命名：AStudent Ⅲ：Dialog：以Dialog结尾，如选择对话框，参考命名为ChoiceDialog Ⅳ：PopWindow：以Pop结尾，如选择popwinwindow，参考命名为ChoicePop。 Ⅴ：网络类：以Service结尾，如首页网络请求，参考命名为：HomeService 其他无举例者严格按照见名知义命名 |
||||||||||||||||||||
| 控件 |
FrameLayout：以fl开头 LinearLayout：以ll开头 RelativeLayout：以rl开头 GridView：以gv开头 ListView：以lv开头 TextView：以tv开头 Button：以btn开头 CheckBox：以check开头 ToggleButton:以btn开头 ImageButton：以btn开头 ImageView：以iv开头 ProgressBar：以pb开头 WebView：以wv开头 ScrollView：sc开头 VideoView：video开头 HorizontalScrollView：以sc开头 EditText：et开头 |
||||||||||||||||||||
| 方法 常量 变量 |
①方法命名必须以小写开头，接下来每个单词驼峰式命名，见名知义，参数名亦如此。 ②常量要统一使用final static来修饰，并且所有字母大写，每个单词之间用下划线(_)连接 ③变量命名以小写开头，要见名知义 补充：所有用到常量的地方要统一将常量写在常量中去引用，而不是哪里用哪里写 参考：
|
||||||||||||||||||||
| 资源文件 |
资源文件统一都是小写，每个单词与每个单词之间用下划线（_）来连接，而不是驼峰式命名 ①动画：需以_anim结尾 ②drawable：如果是图片资源文件，则按照该图片的用处来命名 如果是xml文件，则以drawable_开头 ③layout：如果是activity布局则以activity_开头，如果是fragment则以fragment_开头，如果是ListView的item，则以item_开头，如果是Dialog,则以dialog_开头，如果是PopWindow，则以pop_开头，其他则以layout_开头 ③colors：以color_开头，如color_red ④string:如果是标题则以label_of_开头，如果是button，则以btn_of_开头，如果是hint，则以hint_of_开头，其他则以string_开头。 |
||||||||||||||||||||
| 布局id |
以上面控件缩写开头，并以下划线(_)连接每个单词,所有颜色，尺寸，字符串等必须写在对应的资源文件中去。如果是假数据则不用，但是在实现网络请求后，一定要在布局中将假数据去掉，以免造成上线后带来一些问题。 |
注释
| 类 |
注释该类代表什么，给予一些注释，增加代码可阅读性。 |
| 方法 |
注释该方法是用于做什么，每个方法的参数分别代表什么 |
| 变量/常量 |
注释该变量或者常量代表什么 |
| 控件/布局 |
注释该控件代表什么，该布局代表什么 |
注释规范
单行注释：//+空格+注释内容格式化，如Button btn_login;// 登陆按钮
多行注释：/**/，一般不用
文档注释：/***/,除属性/变量外，其他尽量用文档注释，少用多行注释,如：
/**
*获取名称
*@param name 名称
*/
private void getName(String name){
......
}
代码格式
统一使用Ctrl+Alt+L进行代码格式化