【Android源码 栏目提醒】:网学会员为需要Android源码 的朋友们搜集整理了[计算机]android程序代码规范 - 操作系统相关资料,希望对各位网友有所帮助!
Android代码编程规范 一 开发环境的配置 1. 使用Eclipse 3.5以上的版本 2. eclipse编码格式 请将eclipse编码格式设为UTF-8格式设置方法如下 a. window-Preferences-general-Workspace右 侧Text file encoding选择Other改变为UTF-8以后新建立工程其属性对话框中的Text file encoding即为UTF-8. b. window-Preferences-general-Content Types右侧Context Types树点开Text选择Java Source File在下面的Default encoding输入框中输入UTF-8点Update则设置Java文件编码为UTF-8。
其他java应用开发相关的文件如 properties、XML等已经由Eclipse缺省指定分别为ISO8859-1UTF-8如开发中确需改变编码格式则可以在此指定。
3. 模板和格式模板文件 导入方法下 a. Window-preferences-Java-Code Style-Organize Imports 导入
android.imported b. Window-preferences-Java-Code Style-Formatter导入
android-formatting.xml 4. Tab与空格 a. 程序中不允许出现Tab符号所有的Tab需用4个空格来代替请用如下方法配置 Window-Preferences-General-Editors-Text Editors-Insert spaces for tabs b. XML文件的Tab格式也需要单独配置一下用如下方法配置: Window-Preferences-XML-XML Files-Editor 二程序编写规范 1. 编码 a. 除了String.xml文件中可以出现非英文字符外其他所有的Java文件xml文件中只允许出现英文字符。
b. 所有Java文件UI配置xml文件中不允许出现硬编码。
字符串的国际化请写入String.xml文件配置信息请写入config.xml文件分辨率相关信息请写入dimens.xml文件 2. 变量 a. 变量的命名应具有“自明性”例如声明一个表示电话号码的局部变量可以这么写“String mobileNumber”。
除了for循环中可以使用int ij这样的命名方式其他地方禁止使用这种没有“自明性”的命名 b. 所有静态变量都必须以s开头例如“sMobileNumber” c. 所有的非静态变量必须以m开头例如“mMobileNumber” d. 所有常量必须采用全大写方式单词之间用下划线分割例如“MOBILE_NUMBER”。
此时f.不要再加如“s”或“m”前缀 e. 局部变量的作用域一定要最小化 f. 所有成员变量必须都定义在类的开始定义顺序如下常量-public 变量-private 变量 g. 所有xml配置文件中的变量命名采用全小写命名单词间用下划线分割。
3. 异常处理 a. 尽量不要使用try catch捕获异常而是显式的抛出一个异常。
b. 使用try catch 一定要在catch语句中做好相应的处理不能留空。
在catch中可以赋默认值做错误处理或抛出一个自己封装的异常类对象但不能抛出RuntimeException异常 c. 不要捕获Exception类型的异常 d. 使用Finally这个关键字时需要注意其中的代码执行时间点是无法确定的无法确定是return之前还是之后。
4引入 a. 引用顺序
android第三方包按字母表javax 这是一个graceful的问题 b. 引用方式一定要引全类名不要引用整个包。
例如 imports foo.Bar //right imports foo. //wrong 4. 注释 a. 文件开头要有CopyRight Statement声明结束后空一行写代码非必须 b. 每个类都要有描述注释 c. 方法一定要写注释描述功能参数返回值重要的变量要有注释 5. 括号 所有的复合语句必须用花括号包围例如 if condition body // 标准 6. TODO的使用 当有需要在未来完成的工作时加上TODO注释并给出触发事件或者时间点 // TODO: Remove this code after the UrlTable2 has been checked in. // TODO: Change this to use a flag instead of a constant. 7. 提高代码质量 a. 删除无用的变量 b. 删除无用的引入 c. 对于可以复用的部分一定提取成共用的方法减少代码量 d. 变量/方法命名一定要符合清晰易懂不用太在乎长度 e. 代码完成后进行code review减少出错几率 8. Log的使用 在调试中应该使用Log查找问题但在版本release之前一定要将所有的Log关闭。
代码要使用规范的TAG和调试开关方便以后查找和关闭例如 private static final boolean DBG true private static final String TAG MediaScanner ifDBG Log.dTAGdebug info 在调试中应该使用Log查找问题但在版本release之前一定要将所有的Log关闭。
代码要使用规范的TAG和调试开关方便以后查找和关闭。
为了方便对Log行为做全局控制重新封装出LogUtil类。
新的调用方式如下 private static final String TAG MediaScanner LogUtil.dTAGdebug info 9. 测试代码 在正规开发中一定要有测试的环节
android有自己一套测试的工具 。
具体的写法可以参考
Android的系统源代码。
上一篇:
Android应用程序的Activity启动过程简要介绍和学习计划
下一篇:
“群众路线”:内涵、逻辑与特质心得体会