欢迎来到天天文库
浏览记录
ID:56907372
大小:93.50 KB
页数:26页
时间:2020-07-23
《java编码规范(建议稿,修改自华为规范) .doc》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、武汉中软卓越科技有限公司Java语言编码规范TableofContents目录1.范围32.术语和定义33.排版规范43.1.规则43.2.建议64.注释规范74.1.规则74.2.建议125.命名规范155.1.规则155.2.建议166.编码规范186.1.规则186.2.建议227.JTEST规范247.1.规则247.2.建议251.范围本规范规定了使用Java语言编程时排版、注释、命名、编码和JTest的规则和建议。本规范适用于使用Java语言编程的案例、产品和项目。2.术语和定义规则:编程时强制必须遵守的原则。建议:编程时必须加以考虑的原则。格式:对此规范格式的说明。说明:对此规
2、范或建议进行必要的解释。示例:对此规范或建议从正、反两个方面给出例子。1.排版规范1.1.规则1.1.1.*程序块要采用缩进风格编写,缩进的空格数为4个。说明:对于由开发工具自动生成的代码可以有不一致。1.1.2.*语句块分隔符左括号‘{’应与语句块引用代码在同一行,右括号‘}’应另起一行并与语句块引用代码左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例:如下例子不符合规范。for(...){...//programcode}if(...){...//programcode}voidexample_fu
3、n(void){...//programcode}应如下书写:for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}1.1.3.*较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。示例:if(filename!=null&&newFile(logPath+filename).length()4、ogramcode}publicstaticLogIteratorread(StringlogType,DatestartTime,DateendTime,intlogLevel,StringuserName,intbufferNum)1.1.4.*不允许把多个短语句写在一行中,即一行只写一条语句示例:如下例子不符合规范。LogFilenamenow=null;LogFilenamethat=null;应如下书写:LogFilenamenow=null;LogFilenamethat=null;1.1.1.*if,for,do,while,case,switch,default等语句自占一行5、,且if,for,do,while等语句的执行语句无论多少都要加括号{}。示例:如下例子不符合规范。if(writeToFile)writeFileThread.interrupt();应如下书写:if(writeToFile){writeFileThread.interrupt();}1.1.2.*相对独立的程序块之间、变量说明之后必须加空行。示例:如下例子不符合规范。if(log.getLevel()6、dLevel()){return;}LogWriterwriter;intindex;1.1.3.*在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在Java语言中括号已经是最清晰的标志了。在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不7、加空格。给操作符留空格时不要连续留两个以上空格。示例:(1)逗号、分号只在后面加空格。inta,b,c;(2)比较操作符,赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。if(current_time>=MAX_TIME_VALUE)a=b+c;a*=2;a=b^2;(3)"!"、"~"、"++"、"--"、"&"(地址运算
4、ogramcode}publicstaticLogIteratorread(StringlogType,DatestartTime,DateendTime,intlogLevel,StringuserName,intbufferNum)1.1.4.*不允许把多个短语句写在一行中,即一行只写一条语句示例:如下例子不符合规范。LogFilenamenow=null;LogFilenamethat=null;应如下书写:LogFilenamenow=null;LogFilenamethat=null;1.1.1.*if,for,do,while,case,switch,default等语句自占一行
5、,且if,for,do,while等语句的执行语句无论多少都要加括号{}。示例:如下例子不符合规范。if(writeToFile)writeFileThread.interrupt();应如下书写:if(writeToFile){writeFileThread.interrupt();}1.1.2.*相对独立的程序块之间、变量说明之后必须加空行。示例:如下例子不符合规范。if(log.getLevel()6、dLevel()){return;}LogWriterwriter;intindex;1.1.3.*在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在Java语言中括号已经是最清晰的标志了。在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不7、加空格。给操作符留空格时不要连续留两个以上空格。示例:(1)逗号、分号只在后面加空格。inta,b,c;(2)比较操作符,赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。if(current_time>=MAX_TIME_VALUE)a=b+c;a*=2;a=b^2;(3)"!"、"~"、"++"、"--"、"&"(地址运算
6、dLevel()){return;}LogWriterwriter;intindex;1.1.3.*在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在Java语言中括号已经是最清晰的标志了。在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不
7、加空格。给操作符留空格时不要连续留两个以上空格。示例:(1)逗号、分号只在后面加空格。inta,b,c;(2)比较操作符,赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。if(current_time>=MAX_TIME_VALUE)a=b+c;a*=2;a=b^2;(3)"!"、"~"、"++"、"--"、"&"(地址运算
此文档下载收益归作者所有