欢迎来到天天文库
浏览记录
ID:40557889
大小:91.50 KB
页数:17页
时间:2019-08-04
《Java代码书写规范(高手必经之路)》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、u符号命名规则符号名包括:模块名,变量名,常量名,方法(函数/子程序)名,数据区名,缓冲区名等。符号命名通常应遵循以下规则:通用规则:1、在所有命名中,都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写,除非该名字描述的是中文特有的内容,如半角、全角,声母、韵母等。2、所有命名都应遵循达意原则,即名称应含义清晰、明确。3、所有命名都不易过长,应控制在规定的最大长度以内。4、所有命名都应尽量使用全称。5、如果命名使用缩写,则必须对其进行注释和说明。具体规范:1、工程名统一制订。2、文件名文件名应与类名相同,这是java的规范3、方法名/
2、函数名²·方法名第一个单词小写。²·推荐使用动宾结构。方法名应清晰反映该方法的功能、用途。²·方法名最长不得超过30个字符。例:getCollection();setCollection();insertObject();deleteObject();3、变量名必须使用有意义的变量名。推荐的类型缩写(type)——·char:ch·boolean:b·int:i·long:l·double:d·float:f变量名最长不得超过20个字符。4、类名²·必须以大写字母开头,类名反映具体含义,以清晰表达类的用途和功能为原则²·当名称由多个单词
3、构成时,每一个单词的第一个字母必须大写u代码书写规范书写规范即在编写代码过程中所使用的标准格式,主要包括空格的使用、括号的使用、缩近格式和其他一些内容。源代码书写规范1.在.java/.jsp的开头应有一段格式统一的说明,内容包括:a.文件名(Title/FileName);b.创建人(Author);c.文件创建时间(Date);d.简短说明文件功能、用途(Description/Function)。样例:/***标题:Schedule.java*描述:用来实现计划项目审批*创建:2001-06-30*作者:赵文正*详细:详细描述计划
4、项目审批的细节,如何根据细节功能确定方法*/2.除非极其简单,否则对函数应有注释说明。内容包括:功能、入口/出口参数,必要时还可有备注或补充说明。3.每行代码的长度推荐为80列,最长不得超过120列;折行以对齐为准。4.在类的成员函数内调用其他类的成员函数时,其他类的成员函数可做简短说明。6.函数入口参数有缺省值时,应注释说明。例:floatgetValue(intID,booleanflag){/*parameterdescriptionID:IdentifyNoflag:default=TRUE*/…}7.elseif必须写在一行。
5、8.与‘{’、‘}’有关的各项规定:① ‘{’、‘}’应独占一行。在该行内可有注释。例:正确:for(i=0;i0){m=1;n++;}不得写做:if(i>
6、0){m=1;n++;}①在循环、分支之后若只有一行代码,虽然可省略‘{’、‘}’,但不推荐这么做。若省略后可能引起歧义,则必须加上‘{’、‘}’。例:正确:if(n==-2){n=1;}elseif(n!=nTemp){n=2;}else{n=3;}不得写做:if(n==-2)n=1;elseif(n!=nTemp)n=2;elsen=3;9.与空格有关的各项规定。①所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘.’、‘[’、‘]’等运算符前后,及‘&’(取地址)等运算符之后不得有空格。例:正确:intn=0
7、,nTemp;for(inti=nMinLine;i<=nMaxLine;i++)不得写做:intn=0,nTemp;for(inti=nMinLine;i<=nMaxLine;i++)②or、while、if等关键词之后应有1个空格,再接‘(’,之后无空格;在结尾的‘)’前不得有空格。例:正确:if(-2==n)不得写做:if(-2==n)或if(-2==n)等等。③调用函数时,‘(’、‘)’前后不得有空格。④类型强制转换时,‘(’‘)’前后不得有空格10.与缩进有关的各项规定① 缩进以Tab为单位。1个Tab为4个空格② 下列情况,
8、代码缩进一个Tab:函数体相对函数名及‘{’、‘}’。if、else、for、while、do等之后的代码。一行之内写不下,折行之后的代码,应在合理的位置进行折行。若有+-*/等运算符,则运算符应在上一行末
此文档下载收益归作者所有