Android发编码及文档规范.doc

编码及文档规范 （Android） 作 者: 韩瑜 创建日期: 2015-11-16 更新日期: 2015-11-18 文档编号: 当前版本: 1.0 版本控制 变更记录 （操作：创建、新增、修改、发布、删除） 版本 日期 操作 作者 变更说明 V0.1 2015/11/18 创建 韩瑜 V0.2 审阅 姓名 职位 分发 拷贝编号 姓名 位置/岗位 1 2 3 4 The copy numbers referenced above should be written into the Copy Number space on the cover of each distributed copy. If the document is not controlled, you can delete this table, the Note To Holders, and the Copy Number label from the cover page. 目 录 1 编写目的 4 2 适用范围 4 3 编码规范 4 3.1 编码 4 3.2 基本格式 4 3.3 对齐 6 3.4 空行空格 7 3.5 断行 9 3.6 注释 12 3.7 命名规则 16 3.8 声明 21 3.9 表达式与语句 22 4 类接口与android 25 4.1 类和接口 25 4.2 xml文件书写规范 27 4.3 编码规范 31  编写目的 本规范由编程原则组成，融合并提炼了Android开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格，以达到事半功倍的效果。 适用范围 适用于Android开发的应用。 编码规范 编码 Android代码必须只使用UTF-8编码格式。 基本格式源代码文件（.java）的布局顺序是：包、import语句、类 正例: packagecom.sunsharp; importjava.awt.peer.CanvasPeer; import java.io.*; public class ClassName { } 遵循统一的布局顺序来书写import语句，不同类别的import语句之间用空行分隔。 说明：package语句其后可跟import语句，而且与package间隔一个空行。import包的排列顺序为java开头的包在最前面，接下来是引自外部的包，再接下来是应用程序自身的包，即import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。 正例: packagecom.sunsharp; import java.util.ArrayList; //java自身的包 importjava.util.List; importorg.apache.http.*; //第三方的包 mon.*; //程序自身的包 if、else、else if、for、while、do,switch等语句独占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{} 这样可以防止书写失误，也易于阅读。 正例： if(varible1 varible2) { varible1 = varible2; } 反例： 下面的代码执行语句紧跟if的条件之后，而且没有加{}，违反规则。 if (varible1 varible2) varible1 = varible2; 说明：这样便于程序阅读和查找。 正例： length = 10; width = 5; // 矩形的长与宽关系较密切，放在一起。 strCaption = “Test”; 反例： length = 10; strCaption = “Test”; width = 5; 对齐 3.3.1一般禁止使用制表符，必须使用空格进行缩排。缩进为4个空格 说明：对于利用Eclipse等编程工具的，可以设置TAB键为4个空格代替。消除不同编辑器对制表符处理的差异。 程序的分界符‘{’和‘}’应独占一行，‘}’同时与引用它们的语句左对齐。{ }之内的代码块使用缩进规则对齐。 说明：这样使代码便于阅读，并且方便注释。 do… while语句可以例外，while条件可与 } 在同一行。 正例： voidfunction(intvar) { while (condition) { doSomething(); // 与{ }缩进4格 } //与引用它们的模块左对齐 } 反