开发规范-代码规范

《开发规范-代码规范》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、前言3目的3适用对象3名词解释31排版规范41.1使用Eclipse设置41.2Eclipse代码要求52命名规范72.1基本约定72.2包72.3类、接口72.4方法72.5BL类除getResult()、submitData()夕卜82.6静态变量82.7非静态变量82.8局部变量82.9新建对彖82.10全局变量92.11除CErrors夕卜的全局变量93注释规范93.1基本原则93.2接口、类注释93.3方法注释93.4Eclipse中接口、类、方法快速注释方法103.5代码注释114性能

2、优化基本规则114.1对彖114附件13131.1注释设置文件开发规范刖5目前项目开发没有统一的规范标准，代码具有个人风格，可读性差，不利于长期维护和开发，而且有些不良习惯可能会影响性能。为此制定本文档以规范开发和运维人员在开发中的书写标准。目的提高可读性，风格统一便于维护和开发。提高代码质量，通过规范，逻辑更加严格。适用对象运维人员开发人员名词解释♦运维针对生产环境的Bug或者小需求，进行的代码调整♦开发针对新产站或者大需求，进行的代码调整1排版规范代码的组织和风格统一可使代码可读性提高，容易理

3、解代码。1-1使用Eclipse设置采用eclipse默认的风格Eclipse[built-in],见下图。修改CodeTemplates，导入代码注释模板，见附件一。，见下图:选中代码，点击右键，在菜单中选中source/format,就可以完成基木格式调整，例如括号换行、页宽。1.2Eclipse代码要求•for>while语句为单句时，也需要用括号括起来。例如:Ifd==1){f=ture;}else{f=false;•页宽不得超过100列。•方法从方法名到结尾不得超过100行，除注释外，其

4、他代码都包括。•如果有main方法的话，必须在类的最下方。•不得一行声明多个变量例如：不允许：privateinti,j;允许：privateinti=0,j二0;privateintj;•数组定义规范[]放在类Z后，例如：不允许：Stringstr[];可以：String[]str;2命名规范规范的命名能使程序更易阅读，从而更易于理解。它们也可以提供一些标识功能方面的信息，有助于更好的理解代码和应用。1.1基木约定•使用可以准确说明的英文描述符。例如，采用类似firstName,listAllU

5、sers这样的名字，严禁使用汉语拼音及不相关单词命名，严禁使用汉字命名。•避免使用长名字(不得超过25个字母)。•避免使用相似或者仅在大小写上有区别的名字。•遇到缩写如XM【，时，仅首字母大写，即loadXmlDocument()而不是1oadXMLDocument()。2.2包•—律小写，例如：com.ping,usermanagero2.3类、接口•采用大小写混合的形式。以大写字母开头，名字中其他单词的首字母以大写字母开头，所有其它的单词都为小写字母，严禁使用下划线分隔单词。•以名词或名词短语

6、命名，例如：I后youtManager*、Printer。•接口以Interface为后缀，例如：Containcrlntcrfacco•抽象类以Abstract为前缀，例如1：Abstractcontainer□•缺省或首选实现类以Impl为丿舌缀，例如：ContainerImplo•测试类以Test为后缀，例如：ContainerTesto•异常类以Exccption为后缀，例如：Inva]idArgumcntExccption。2.4方法•采用大小写混合的形式。以小写字母开头，名字中其他单词

7、的首字母以大写字母开头，所有其它的单词都为小写字母，严禁使用下划线分隔单词。•方法的命名应该能描绘出方法的作用和功能，方法的名字建议使用祈使动词或者动词短语,例如：showContState()。•获取或者设置类的某种属性的方法采用以get或set的显式命名，例如：getName()或者setName(),其中Name是指类的属性的名字。•返回布尔属性的方法釆用前缀为is的显式命名，例如：isVisiblo()。•对于己有的、形成通用做法的方法命名不做要求，继续沿用原有命名方式。•LIS中通用做法

8、:submitsData()通过依次调用getlnputDataO>checkDataOdealDataOsprepareOutputData(),完成业务处理。这五个方法(包括submitsData)都是返冋布尔属性的，是LTS的通用做法，故不要求按照返冋布尔属性的方法采用前缀为is的显式命名，沿用原有命名方法。并且每一个BL类必须符合上述规范，主要业务操作必须在dealData()方法内完成。2.5BL类除getResult()>submitData()外•尽量不要新建publ