Android编程规范

1.命名规范:
从正式开始Android开发工作第一天,主管就教我命名规范,这也从侧面反应命名规范的重要性。良好的命名习惯对今后代码的维护更新起很大作用,提高开发效率。

(1)布局文件中的id命名
规则:使用驼峰命名,前缀+逻辑名称,类变量名和布局文件id名称保持一致,不需要下划线分割
控件前缀规则:
TextView/EditText: tv/et
Button/RadioButton/ImageButton: btn
ImageView: img
RelativeLayout/LinearLayout/FrameLayout: layout,
ListView: listView
WebView: webView
CheckBox: chBox
如:TextView @+id/tvTitle
如:EditView @+id/etName
如:Button @+id/btnSearch
(2) 布局文件命名
规则: 使用前缀_逻辑名称命名,单词全部小写,单词间以 下划线 分割。
前缀规则:
Activity对应的布局使用activity_ 有时候类名过长 可简写为aty
Fragment对应的布局使用fragment_ 简写 fgt
如:PublishActivity: activity_publish.xml PublishAty
(3)资源文件命名
规则: 使用 前缀_用途 命名,单词全部小写,单词间以 下划线 分割。
drawable:
btn_back_selector.xml 控件前缀命名
common_circle_gray.xml 通用资源多处使用common_
chat_image_selector.xml 功能相关业务使用加用途前缀
drawable_hdpi:
btn_back_normal.9.png 控件前缀名称
btn_back_press.9.png 控件前缀名称
icon_login_lock.png icon_+用途
values/color:
pull_refresh_attrs.xml 引入的第三方资源,携带资源简拼的前缀
(4)类和接口命名
规则: 使用驼峰规则,首字母必须大写,使用名词或名词词组。要求简单易懂,富于描述,不允许出现无意义或错误单词。
如:class BookMarkAdd 正确
如:class AddBookReadPlan 错误! 应为 class BookReadPlanAdd
(5) 方法的命名
规则: 使用驼峰规则,首字母必须小写,使用动词。要求简单易懂,富于描述,不允许出现无意义或错误单词。
如:public void run();
如:public String getBookName();
(6)变量命名
规则: 使用驼峰规则,首字母必须小写,使用名词或名词词组。要求简单易懂,富于描述,不允许出现无意义或错误单词。
成员变量命名,不要在私有变量前添加m字样
常量命名,全部大写,单词间用下划线隔开

2.编程规范:

这里的编程规范总结的是Android开发中一些常用编程习惯,好的细节,好的习惯也是一个优秀程序员所必备的。

1.Java代码中不要出现中文,最多注释中可以出现中文;代码中不要出现数字,特别是一些标识不同类型的数字,所有意义数字全部抽取到Constant公共类中,避免散布在各位类中;代码任何地方不要拼错单词
2.Activity.onCreate(),Fragment.onActivityCreated(),作为程序入口,不用写入太多代码,尽量保持只调用initXXX()方法,简单明了展示调用过程。如:initData(),initView()。
3.方法使用:单个方法体不要过长,拆分臃肿方法,每个方法只作一件事;做同一个逻辑的方法,尽量靠近放到一块,方便查看;调用方法保持“临近原则”,被调用的方法,放在调用方法下方;
4.空行使用:空行将逻辑相关代码段隔开,简洁清楚,提高可读性。
空行的使用:拒绝拖沓无分割,关联代码段放一块并与后面代码分割;成员变量之间,根据业务形成分组加空行;方法之间加空行
5.控制语句:减少条件嵌套,不要超过3层
if判断使用“卫语句”,减少层级
if(obj != null) { doSomething();}
修改为:
if(obj == null) { return;}doSomething();
if语句必须用{}包括起来,即便是只有一句
6.TODO标记:记录想法,记录功能点,开发过程中可以利用TODO记录一下临时想法或为了不打扰思路留下待完善的说明;删除无用TODO,开发工具自动生成的TODO,或则已经完善的TODO,一定要删除。

3.工具规范:
开发环境,开发工具,项目框架因公司而异,这里总结下常用的工具以及第三方依赖库:
IDE
ADT(已停止更新)
Android Studio (新推出的开发环境)
Android SDK 4.4W (API 20 统一开发版本)
JDK 1.8(统一开发版本)
Libraries
Base
fastjson-android-1.2.4.jar
okhttp-2.2.0.jar
okio-1.2.0.jar
picasso-2.5.0.jar
butterknife:7.0.1
ormlite-android:4.48
volley
xutils
AChartEngine
Universal-Image-Loader
UI
PullToRefresh下拉刷新与上拉加载
QuickAdapter
PagerSlidingTabStrip
SwipeRefreshLayout
SystemBarTint 状态栏以及导航栏设置背景颜色
SwipeBackLayout 左滑返回
PullToZoomView 可以下拉缩放HeaderView
AutoLoopViewPager 轮播图
PhotoView
ViewPageIndicator
许多好看的UI效果可以去安卓巴士,github上面搜索到,这里就不列举太多了。

以上是根据自己开发以及上网查询整理的资料,持续更新中,一起学习。

上一篇:[R]文件处理


下一篇:SwipeRefreshLayout的下拉刷新与上拉加载