Android_项目编码规范.docVIP

Android项目编码规范 介绍 为什么要有编码规范 编码规范对于程序员而言尤为重要，有以下几个原因： - 一个软件的生命周期中，80%的花费在于维护 - 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护 - 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 - 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 为了执行规范，每个软件开发人员必须一致遵守编码规范。 命名规则 由于Android 开发应用中、各个应用的包名一定要区分、否则后安装的应用程序会覆盖先前安装的应用，所以要求各个应用的包名命名需特别关注。 包(Packages) 所有项目包名以 开头。后面是程序所在项目的英文名称，再下为子系统的名称，每个子系统内按照类别区分。 net.sunniwell.swlanucher net.sunniwell.swlanucher.tools 其他命名规则参照“Java代码开发规范” 类变量声明 声明的变量各个部分出现的先后次序 类的（静态）变量。 首先是公共（public）变量，随后是保护（protected）变量，再后是包级别的变量（没有访问修饰符的，默认为friendly），最后是私有（private）变量。 实例变量。 首先是公共（public）变量，随后是保护（protected）变量，再后是包级别的变量（没有访问修饰符的，默认为friendly），最后是私有（private）变量。 private static Object sLock = null; // 静态成员变量以s开头 private int mScreenOff = 0; // 非静态成员变量名以m开头 res/layout文件夹命名规范： 统一用小写和下划线_组合命名，建议xml文件加个前缀以便区分， 如对话框的xml配置文件:dlg_name.xml; res/drawable文件命名规范： 统一用小写加下划线“_”组合命名，同上，每个资源文件最好加个前缀以便区分，如:btn_default.png,btn_pressed.png,btn.xml; 注释 类文件开头 所有的类文件开头、必须要有类的主要作用的简单说明、类创建日期、作者信息、 /* * Classname * Date * @author Author */ 方法注释 1.类该方法什么 2. @param 各个参数说明 3.异常处理。@throws .@return 方法返回值、代表的意义 （如：数值，1：成功，0：失败） 例如： /** * 类方法注释 * @param param1 数据1 * @param param2 数据2 * @return 返回测试值 */ public String getBossId(int param1, int param2) { return bob; } 日志 日志标记统一定义为静态常量类名： 例如： private static final String TAG = CmdInter.class.getSimpleName(); 1