欢迎来到天天文库
浏览记录
ID:16021890
大小:55.50 KB
页数:11页
时间:2018-08-07
《android java代码规范》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、AndroidJAVA开发代码与注释规范说明:1本代码规范如有不合理的地方可以提出进行修改,对于规范有建议可以提出添加,该规范只是个初版,后期可以进行完善并执行。2本规范旨在提高代码可读性,让接手项目的人可以节省代码阅读时间成本。最终主旨可以做到,让小白程序猿都可以看清代码逻辑1代码规范1.1缩进风格程序块要采用缩进风格编写,缩进的空格数为4个。说明:对于由开发工具自动生成的代码可以有不一致。1.2分界符’{’和’}’应与所修改文件或新建文件所在的工程或模块保持一致。分界符’{’和’}’独占一列,与引用它们的语句左对齐,并且不允许空行。(虽然Android中要求分界符
2、’{’不独占一行,但是个人认为分界符独占一行会更有助于代码结构的整理,可以单独区分模块)在函数体的开始、类和借口的定义、以及if、for、do、switch、case语句中的程序都要采用如上的缩进风格示例:不符合规范for(…){…//programcode}voidexample_fun(void){…//programcode}符合规范for(…){…//programcode}voidexample_fun(void){…//programcode}1.3较长的语句、表达式参数较长的语句、表达式活着参数(>100字符)要分成多行书写,长表达式要在低优先级操作符处
3、划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读示例:if(datas!=null&&arraylist.size4、句自占一行,且无论执行语句有多少都要加括号{}。示例:不规范代码if(true)return;应书写如下:if(true){return;}1.6相对独立的程序块之间、变量说明之后必须加空行。示例:不规范代码:if(true){return}Strings1;应书写如下:if(true){return}Strings1;1.7对齐只使用空格,不使用TAB键。(TAB键长度为4个空格)说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐。1.8关键字、变量、常量进行对等操作在两个以上的关键字、变量、常量进行操作时,它们之间的操作符之前、5、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后面不加空格。说明:采用这种方式编写代码的目的是为了使代码更加清晰。由于留空格所产生的清晰性是相对的,所以在非常清晰的语句中没有必要留空格。示例:(1)逗号、分号只在后面加空格。Stringa,b,c;(2)比较操作符“>=”、“==”,赋值操作符“=”、“+=”,算数操作符“+”、“%”,逻辑操作符“&&”,位域操作符“<<”的前后加空格。if(a>=b)a=b+c;a+=2;a=b+2;(3)地址运算符“!”、“++”、“&”等操作符前后不加空格bool=!true;i++;(4)if、f6、or、while、switch等后面的括号间应加空格,可以使关键字更为突出if(true)(5)一行程序的长度不宜过长,以小于80个字符为宜2注释2.1一般情况下,源代码的有效注释量必须在20%以上说明:注释的原则是有助于对程序的阅读理解,在改加的地方都加,尽量做到明确,易懂,简洁。2.2类说明性注释说明:在每个类的头部,都应该列出生成时间,作者,功能,修改历史修改历史在每次对该类进行修改的时候进行添加示例:/***生成时间:2017-09-10*作者:wyj*功能:这是一个界面*生成版本号:1.1.0*修改历史:*作者,版本,新增功能,新增时间(这里尽量用简述)*(7、其他的语言进行注释的时候可能需要有其他说明,可在添加)*/publicclassactivity(){}2.3功能性方法说明性注释说明:在功能性方法的头部,都应该列出该方法的时间,作者,功能,返回值,传入参数,以及修改历史示例:/***时间:2017-09-10*作者:wyj*功能:这是一个方法*return:这里返回一个字符串(返回值说明)*s1:这是第一个参数(参数说明)*s2:这是第二个参数()*修改历史:(同2.2)*/publicintdata(Strings1,Strings2){returns1}2.4要养成边写代码边注释的习惯,修改代
4、句自占一行,且无论执行语句有多少都要加括号{}。示例:不规范代码if(true)return;应书写如下:if(true){return;}1.6相对独立的程序块之间、变量说明之后必须加空行。示例:不规范代码:if(true){return}Strings1;应书写如下:if(true){return}Strings1;1.7对齐只使用空格,不使用TAB键。(TAB键长度为4个空格)说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐。1.8关键字、变量、常量进行对等操作在两个以上的关键字、变量、常量进行操作时,它们之间的操作符之前、
5、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后面不加空格。说明:采用这种方式编写代码的目的是为了使代码更加清晰。由于留空格所产生的清晰性是相对的,所以在非常清晰的语句中没有必要留空格。示例:(1)逗号、分号只在后面加空格。Stringa,b,c;(2)比较操作符“>=”、“==”,赋值操作符“=”、“+=”,算数操作符“+”、“%”,逻辑操作符“&&”,位域操作符“<<”的前后加空格。if(a>=b)a=b+c;a+=2;a=b+2;(3)地址运算符“!”、“++”、“&”等操作符前后不加空格bool=!true;i++;(4)if、f
6、or、while、switch等后面的括号间应加空格,可以使关键字更为突出if(true)(5)一行程序的长度不宜过长,以小于80个字符为宜2注释2.1一般情况下,源代码的有效注释量必须在20%以上说明:注释的原则是有助于对程序的阅读理解,在改加的地方都加,尽量做到明确,易懂,简洁。2.2类说明性注释说明:在每个类的头部,都应该列出生成时间,作者,功能,修改历史修改历史在每次对该类进行修改的时候进行添加示例:/***生成时间:2017-09-10*作者:wyj*功能:这是一个界面*生成版本号:1.1.0*修改历史:*作者,版本,新增功能,新增时间(这里尽量用简述)*(
7、其他的语言进行注释的时候可能需要有其他说明,可在添加)*/publicclassactivity(){}2.3功能性方法说明性注释说明:在功能性方法的头部,都应该列出该方法的时间,作者,功能,返回值,传入参数,以及修改历史示例:/***时间:2017-09-10*作者:wyj*功能:这是一个方法*return:这里返回一个字符串(返回值说明)*s1:这是第一个参数(参数说明)*s2:这是第二个参数()*修改历史:(同2.2)*/publicintdata(Strings1,Strings2){returns1}2.4要养成边写代码边注释的习惯,修改代
此文档下载收益归作者所有