java_web编码规范

《java_web编码规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、文档安全级别：内部类Java编码规范版本V1.0信息技术部编制日期：2009年2月18日文档安全级别:□普通类■内部类□限制类□绝密类文档修改历史记录第38页共38页文档批准角色姓名职责签名审批日期第38页共38页JAVA编码规范11.说明82.命名规范82.1.Package的命名规范82.2.Class命名规范92.3.Method命名规范112.4.变量命名规范123.注释规范133.1.变更履历注释规范143.2.类头注释规范143.3.成员注释规范163.4.方法注释规范173.5.代码修改注释规范184.排版规范184.1.详细规范内容185.语句规范215.1.

2、控制语句风格规范215.2.命令语句风格规范235.3.声明语句风格规范266.设计规范276.1.复杂度控制规范276.2.Class设计规范286.3.Method设计规范296.4.变量设计规范317.常用类规范327.1.Object整体规范327.2.修饰符规范337.3.字符串规范357.4.数值规范377.5.集合规范37第38页共38页7.6.Stream规范387.7.例外规范397.8.线程规范408.日志规范428.1.详细规范内容42第38页共38页说明本文对《Web应用系统开发规范》作适当扩充，规定了Java编程的规范，主要包括命名、注释、排版、语句

3、、设计、常用类以及日志规范。统一规范的格式有利于项目的交付和后续维护。本文档适用于所有以Java为开发语言的定制开发应用系统。1.命名规范命名规范使程序易读，从而更易于理解。1.1.Package的命名规范1.1.1.Package名要使用小写字如无特殊规定，请将Package名统一成小写字。这是Java的一般规则。例如：com.citicpru.fins.Banking.ACCOUNT//错误com.citicpru.fins.banking.account//正确1.1.2.Package名要有意义尽量给Package命名一个能联想到Package内容的名字。如果使用功能

4、ID、流水号等来命名Package的话，不能马上明白其意思。遵守此规范，将提高代码的易读性。例如：com.citicpru.fins.banking.a00001//错误com.citicpru.fins.banking.account//正确1.1.3.Package名不应缩写即使Package名长，也请尽量不要缩写，而使用易懂的名字。例如：第38页共38页com.citicpru.fins.bkｇ.acc//错误com.citicpru.fins.banking.account//正确1.1.1.Package名的组成标准的package名分为三部分：<公司名>.<应用系

5、统名>.<模块名>，本公司<公司名>均使用com.citicpru。例如：com.pksoft.fins.banking.account//错误com.citicpru.fins.banking.account//正确1.2.Class命名规范1.2.1.Class的名称应该是一个名词短语Class的名称应是“形容词/名词+名词”的形式。例如：publicclassSomethingManage{//错误publicclassSomethingManagement{//正确1.2.2.Class名要能体现其作用Class名中，请不要使用功能ID、流水号等难懂的名字。Class

6、名要使用有意义的字符串，以便能联想到其Class的内容。这样将提高代码的易读性。例如：publicclassS0001{//错误publicclassSample{//正确1.2.3.Class名中单词的第1个字母要大写请大写Class名的第1个字母。当Class名由多个单词组成时，每个单词的第1个字母（段落）都要大写,其余字母小写。这是Java的一般规则。例如：publicclasssampleclass{//错误publicclassSampleClass{//正确第38页共38页1.1.1.例外Class名的最后要加上“Exception”对例外Class名，请在名字最

7、后加上“Exception”。统一此写法，将提高代码的易读性。例如：publicclassSampleextendsException{//错误publicclassSampleExceptionextendsException{//正确1.1.2.Interface名要基于Class名Interface的命名规则基本上要基于Class名。统一此写法，将提高代码的易读性。如果需要与Class名区分，请在开头加上“I”。例如：publicclassSampleimplementsISample{1.1.3