android发编码及文档规范

《android发编码及文档规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、《开发编码及文档规范》编码及文档规范（Android）作者:韩瑜创建日期:2015-11-16更新日期:2015-11-18文档编号:当前版本:1.0©3TISolutionsAllrightsreserved.32/32《开发编码及文档规范》版本控制变更记录（操作：创建、新增、修改、发布、删除）版本日期操作作者变更说明V0.12015/11/18创建韩瑜V0.2审阅姓名职位分发拷贝编号姓名位置/岗位1234Note:ThecopynumbersreferencedaboveshouldbewrittenintotheCopyNumberspaceonthecoverofeachdistri

2、butedcopy.Ifthedocumentisnotcontrolled,youcandeletethistable,theNoteToHolders,andtheCopyNumberlabelfromthecoverpage.©3TISolutionsAllrightsreserved.32/32《开发编码及文档规范》目录1编写目的42适用范围43编码规范43.1编码43.2基本格式43.3对齐63.4空行空格73.5断行93.6注释123.7命名规则163.8声明213.9表达式与语句224类接口与ANDROID254.1类和接口254.2xml文件书写规范274.3编码规范31©3

3、TISolutionsAllrightsreserved.32/32《开发编码及文档规范》1编写目的本规范由编程原则组成，融合并提炼了Android开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格，以达到事半功倍的效果。2适用范围适用于Android开发的应用。3编码规范3.1编码Android代码必须只使用UTF-8编码格式。3.2基本格式3.2.1源代码文件（.java）的布局顺序是：包、import语句、类正例:packagecom.sunsharp;importjava.awt.peer.CanvasPeer;importjava.io.*;publicclassCl

4、assName{}©3TISolutionsAllrightsreserved.32/32《开发编码及文档规范》3.2.2遵循统一的布局顺序来书写import语句，不同类别的import语句之间用空行分隔。说明：package语句其后可跟import语句，而且与package间隔一个空行。import包的排列顺序为java开头的包在最前面，接下来是引自外部的包，再接下来是应用程序自身的包，即import中标准的包名要在本地的包名之前，而且按照字母顺序排列。正例:packagecom.sunsharp;importjava.util.ArrayList;//java自身的包importjava

5、.util.List;importorg.apache.http.*;//第三方的包importcom.snusharp.common.*;//程序自身的包3.2.3if、else、elseif、for、while、do,switch等语句独占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}这样可以防止书写失误，也易于阅读。正例：if(varible1

6、系较为紧密的代码应尽可能相邻。说明：这样便于程序阅读和查找。正例：length=10;width=5;//矩形的长与宽关系较密切，放在一起。strCaption=“Test”;反例：length=10;©3TISolutionsAllrightsreserved.32/32《开发编码及文档规范》strCaption=“Test”;width=5;1.1对齐3.3.1一般禁止使用制表符，必须使用空格进行缩排。缩进为4个空格说明：对于利用Eclipse等编程工具的，可以设置TAB键为4个空格代替。消除不同编辑器对制表符处理的差异。3.3.2程序的分界符‘{’和‘}’应独占一行，‘}’同时与引用它

7、们的语句左对齐。{}之内的代码块使用缩进规则对齐。说明：这样使代码便于阅读，并且方便注释。do…while语句可以例外，while条件可与}在同一行。正例：voidfunction(intvar){while(condition){doSomething();//与{}缩进4格}//与引用它们的模块左对齐}反例：voidfunction(intvar){while(condition){doSomething