编码规范以开发手册

《编码规范以开发手册》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、1.软件开发手册1.1.范围本标准规定了基于公司信息系统构建平台进行业务应用系统开发的编程格式规范，主要包括命名规范、代码注释、性能、以及常用语句的书写要求和约束等。统一规范的格式有利于项目的交付和后续维护。1.2.引言1.1.1.简介所有的程序开发手册都包含了各种规则。一些习惯自由程序的人（例如Java程序员）可能对这些规则很不适应，但是在多个开发人员共同协作的情况下，这些规则是必需的。这不仅仅是为了开发效率，而且也为了测试和后期维护。良好的编码习惯有助于标准化程序的结构和编码风格，使源代码对

2、于自己和别人都易读和易懂。在开发周期中越早使用恰当的编码规定，将会最大程度的提高项目的生产率。良好的编码习惯除了代码格式，详细的注释外，还应该包括使用有助于提高程序效率的编码方式。规范的开发有助于提高源码的可读性，可维护性，对于提高项目的整体效率更是不可缺少的（尤其是团队开发）。1.1.2.目的本文是一套面向Javaprogrammer和Javadeveloper进行开发所应遵循的开发规范。按照此规范来开发Java程序可带来以下益处：l代码的编写保持一致性，l提高代码的可读性和可维护性，l在团队

3、开发一个项目的情况下，程序员之间可代码共享，l易于代码的回顾。1.3.源程序1.3.1.源程序命名Java源程序的名字应该是这种形式：ClassOrInterfaceName.java。ClassOrInterfaceName应该是在Java源程序中定义的class或者interface的名字（关于classes和interface的命29名规范请参考3.2）。源程序的文件名后缀通常为.java。1.1.1.供发布的文件如果文件编译后，需要用打包的形式发布，那么这个包的名字应该是有代表性的（例如

4、应该是这个模块或者这个文件所在单元的名字）。通常包的扩展名有*.jar(推荐使用)或者*.zip、*.ear、*.war等。1.1.2.源文件的组织一个Java源文件应该包含如下的元素，并按照以下顺序书写：1)版本信息和版权声明2)包的声明3)引用声明4)类或者接口的声明以上元素之间以至少一个空行来分隔。1.1.2.1.版本信息和版权声明每一个源程序应该以一个包含版本信息和版权声明的块为开始。例如：/***

applicationname：sample1

application

5、describing：thisclasshandelstherequestoftheclient

copyright：Copyright®2002金质工程版权所有

company：neusoft

time：2002.02.25

6、getelmecall.presentation.util;1.1.1.2.引用声明import语句应该从第一列开始，并用一个空格分隔import关键字和importtypename。引用时应保证所有引入类都被使用，即减少引入*的使用，因为如果引入不确切的类将很难理解当前类的上下文关系及相关性。例如：importtelmecall.presentation.view.bookview//GOODimporttelmecall.presentartion.*//NOTGOOD1.1.1.3.类或者

7、接口的声明每个源程序至少会有一个class或者interface的声明。1.2.命名规范1.2.1.包的命名包的名字应该都是由小写单词组成。它们全都是小写字母，即便中间的单词亦是如此。例如：packagetelmecall.business.console;packagetelmecall.business.exception;packagetelmecall.presentation.util;其中telmecall指项目名称business/presentation指业务逻辑和表现层cons

8、ole/exception/util指具体模块1.2.2.类和接口的命名类和接口的名字一般由大写字母开头而其他字母都小写的单词组成（但一些专有的缩写词，比如：AWTException等则除外）。29类的命名Class的名字建议使用名词或者名词短语。例如：//好的类命名：LayoutManager，ArrayIndexOutOfBoundsException//不好的类命名：ManageLayout//动词短语，建议用名词短语awtException//awt是专有名词，都应该大写array_in