安卓开发规范.doc

安卓开发规范 编写目的 为了使项目文档组织有序，方便项目组成员协调开发工作，便于后期开发人员理解和维护代码，公司的android开发项目应该有一套命名规范，小组人员在编写代码时应该遵循这些规范，使用有意义的字符书写代码中得类型、变量，形成良好的编码风格。 简单描述 工程文件编码格式：UTF-8 包结构 src的目录结构 com.hy.prss.mobile.android.constant 例如：Server_Config.java 描述：包下的所有类里只能装常量，常量格式public static final xxx XXX = xxx; R.id.xxx类似的资源文件不能定义在arrays里，定义在常量包里方便调用 com.hy.prss.mobile.android.widget 例如：IconTextListView.java，PictureDialog.java 描述：包下的所有类里只能是自定义控件或自定义dialog com.hy.prss.mobile.android.entity 例如：User.java 描述：包下的所有类里只能是属性变量+get和set方法 com.hy.prss.mobile.android.activity 例如：MainActivity.java MyActivity是所有的Activity的父类，对Activity的统一的处理在MyActivity实现，如：对顶部标题栏的显示和底部标题栏的显示 Activity的作用: 加载layout, 初始化控件，设置监听，处理监听事件 描述：所有活动的集合 com.hy.prss.mobile.android.service 例如：UserManager.java 描述：业务层 com.hy.prss.mobile.android.dao 例如：SqlDBHelper.java 描述：数据访问 com.hy.prss.mobile.android.util 例如：XmlUtil.java 描述：所有的零碎功能 包括处理XmlUtil, JsonUtil，SharedPreferencesUtil, DBUtil，FileUtil，HttpUtil，SocketUtil，StringUtil, DeviceUtil com.hy.prss.mobile.android.app 例如：MyService.java 描述： 存放Broadcast，service, application 所有的Service继承MyService 服务： 用在不需要界面时，还需要长时间在后台运行的地方 广播： 用来接收系统 广播用于处理后台服务与前台界面的交互 com.hy.prss.mobile.android.test 例如： 描述： junit test模块测试 values的目录结构 代码规范 java代码命名规范 类名、接口命名规则 类和接口的名称应该是一个名词，与设计文档保持一致； 采用大小写混和的方式，每个单词的首字母大写； 命名使用完整单词，禁止使用中文全拼，如使用缩写词必须添加注释（除非该缩写词被广泛的使用，如URL、HTML）； 例如 class UserTest;//各单词首字母大写 interface IUserTest;//接口以大写I开头 abstract class AbsUserTest; //抽象类以Abs开头 方法函数命名规则 方法名应该是动词/动名词，采用大小写混和方式，第一个单词首字母小写，其后单词的首字线大写。 例如 run() runFase() 变量命名规则 变量命名采用大小写混和的方式，第一个单词首字母小写，其后单词的首字母大写。变量名应简短有意义； 尽量避免单个字符的变量名（临时变量除外）； 所有变量要显式的赋值； 静态变量命名采用全大写字母，中间用下划线分隔。 例如 int total = 0; String name = null; Button bnStart = new Button(); static int MAX_CODE_LINE = 200; 资源文件代码命名规范 命名文件名 因为该文件名不识别大写字符，所有单词间以下划线分割 例如：activity_main 命名内部属性名 参考变量命名规则 例如: bnStart styleDialog widget缩写对应表 因为widget比较常用所以特用缩写代替 缩写对应如下： TextView tv EditText et WebView wv ImageView iv VideoView vv MediaController mc ListVi