Java代码编程规范1

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

1、技术文件文件名称：JAVA代码编程规范文件编号：版本:V2.0文件等级：共37页(包括封面)项目名称:项目代码:拟制：郭军，曹阳单位：网络资源开发部日期：2002年8月22日深圳市中兴通讯股份有限公司第37页目录1概述41.1编程规范的必要性41.2规范文档的一些要求41.3如何使代码简洁42源文件的组织52.1Java源文件52.1.1文档开头的注释52.1.2Package和Import声明52.1.3类和接口声明53文档的缩进规则53.1行的长度53.2代码行的分割54代码的注释规则84.1代码注释的基本原则84.2注释的运用84.3I

2、mplementation注释的格式94.3.1块注释94.3.2单行注释94.3.3后注释(trailing)104.3.4行尾注释(End-of-line)104.4文档型注释(Documentation)104.4.1位置114.4.2javadoc标签的使用124.4.3加入样例代码124.4.4生成javadoc文档135变量的声明145.1每行变量声明个数145.2变量初始化145.3变量声明的位置145.4类和接口的声明156语句166.1简单语句166.2复合语句166.3返回语句166.4if，if-else，ifelse-

3、ifelse语句166.5for语句176.6while循环语句176.7do-while语句176.8switch语句176.9try-catch语句18第37页7空行和空格的使用187.1空行的使用187.2空格的使用198命名规范198.1命名的基本原则208.2成员函数的命名规则208.2.1成员访问函数的命名208.3属性域（fields/property）的命名218.3.1组件的命名218.4常量的命名228.5数组的命名228.6局部变量的命名标准228.6.1流（Streams）的命名228.6.2循环变量的命名228.6.

4、3异常（Exception）处理中的命名238.6.4通用对象命名约定238.7类、接口、包的命名239编程规范239.1访问类变量和实例239.2类变量和方法239.3常量259.4变量的声明259.5几个注意点259.5.1括号259.5.2返回值269.5.3条件运算中的表达式2610编码实例2610.1JAVA源文件的例子2611总结和索引2911.1JAVA命名规范2911.2JAVA文档注释规范2911.2.1基本原则2911.2.2注释的内容3111.3JAVA编码规范3212警惕内存泄漏3313J2EE命名规范3413.1EJ

5、B包结构3413.2Servlet包结构3613.3通用工具包结构3613.4JNDI名称3714参考书目3715细节37第37页概述1.1编程规范的必要性代码编程规范之所以重要是因为：l软件生命周期中的80%时间是软件维护期；l几乎没有任何软件在其整个生命周期中一直由它的原作者来负责维护；l代码编程规范能够增加软件的可读性，使得软件工程师更快更准确地理解新代码l编程规范能提高软件的封装性；1.2规范文档的一些要求后面文中将深入讨论结构良好的程序文档的规则和要求。一个结构良好的文档应首先做到以下几点。l文档注释应能增加代码的可读性编写注释的目

6、的是使你、你的开发伙伴以及后续的开发人员更好地理解你的代码。SUN公司JAVA开发组的Nagle曾说过“如果程序不值得写文档的话，意味着代码也不值得运行”。l避免文档的过度修饰六七十年代的COBOL语言开发着有一种注释习惯，通常用星号画一个方盒子来填写注释。这样做的确很好看，但对于最终产品来讲没有太多的益处。应当注意文档中注释和代码的比例，代码的注释应当简洁、明了。l在编码前就开始写文档原则上讲，我们看一段代码总能发现它在做什么。例如，下面这段代码中，我们能分析出代码的行为，但不能真正看出它的确切语义。If(grandTotal>=1000.

7、00){grandTotal=grandTotal*0.95;}在注释文档中应说明代码所表达的语义和编码设计思想，而不应只是就事论事的讲述代码的行为。1.3如何使代码简洁l为代码写注释文档l将代码从逻辑上分段l合理的使用空行l遵守“30秒规则”，提高代码的可读性l书写较短的代码行第37页1源文件的组织一个JAVA源文件是由用空白行和注释分隔开的很多部分组成的，通常文件长度应该小于2000行。1.1Java源文件每一个Java源文件都包括一个公共的类或接口。当私有类或接口与公共类相关联的时候，通常可以将其与公共类放在同一个源文件当中。公共类应是

8、文件中的第一个类或接口。Java源文件的组织结构如下：l文件开始的注释段lPackage和Import的声明l类和接口声明1.1.1文档开头的注释所有源文件的开始部