Java代码编程规范.doc

目 录 1 概述 4 1.1 编程规范的必要性 4 1.2 规范文档的一些要求 4 1.3 如何使代码简洁 4 2 源文件的组织 5 2.1 Java源文件 5 2.1.1 文档开头的注释 5 2.1.2 Package和Import声明 5 2.1.3 类和接口声明 5 3 文档的缩进规则 5 3.1 行的长度 5 3.2 代码行的分割 5 4 代码的注释规则 8 4.1 代码注释的基本原则 8 4.2 注释的运用 8 4.3 Implementation注释的格式 9 4.3.1 块注释 9 4.3.2 单行注释 9 4.3.3 后注释(trailing) 10 4.3.4 行尾注释(End-of-line) 10 4.4 文档型注释(Documentation) 10 4.4.1 位置 11 4.4.2 javadoc标签的使用 12 4.4.3 加入样例代码 12 4.4.4 生成javadoc文档 13 5 变量的声明 14 5.1 每行变量声明个数 14 5.2 变量初始化 14 5.3 变量声明的位置 14 5.4 类和接口的声明 15 6 语句 16 6.1 简单语句 16 6.2 复合语句 16 6.3 返回语句 16 6.4 if，if-else，if else-if else语句 16 6.5 for语句 17 6.6 while 循环语句 17 6.7 do-while 语句 17 6.8 switch语句 17 6.9 try-catch 语句 18 7 空行和空格的使用 18 7.1 空行的使用 18 7.2 空格的使用 19 8 命名规范 19 8.1 命名的基本原则 20 8.2 成员函数的命名规则 20 8.2.1 成员访问函数的命名 20 8.3 属性域（fields/property）的命名 21 8.3.1 组件的命名 21 8.4 常量的命名 22 8.5 数组的命名 22 8.6 局部变量的命名标准 22 8.6.1 流（Streams）的命名 22 8.6.2 循环变量的命名 22 8.6.3 异常（Exception）处理中的命名 23 8.6.4 通用对象命名约定 23 8.7 类、接口、包的命名 23 9 编程规范 23 9.1 访问类变量和实例 23 9.2 类变量和方法 23 9.3 常量 25 9.4 变量的声明 25 9.5 几个注意点 25 9.5.1 括号 25 9.5.2 返回值 26 9.5.3 条件运算中的表达式 26 10 编码实例 26 10.1 JAVA源文件的例子 26 11 总结和索引 29 11.1 JAVA命名规范 29 11.2 JAVA文档注释规范 29 11.2.1 基本原则 29 11.2.2 注释的内容 31 11.3 JAVA编码规范 32 12 警惕内存泄漏 33 13 J2EE命名规范 34 13.1 EJB包结构 34 13.2 Servlet包结构 36 13.3 通用工具包结构 36 13.4 JNDI名称 37 14 参考书目 37 15 细节 37 概述 编程规范的必要性 代码编程规范之所以重要是因为： 软件生命周期中的80%时间是软件维护期； 几乎没有任何软件在其整个生命周期中一直由它的原作者来负责维护； 代码编程规范能够增加软件的可读性，使得软件工程师更快更准确地理解新代码 编程规范能提高软件的封装性； 规范文档的一些要求 后面文中将深入讨论结构良好的程序文档的规则和要求。一个结构良好的文档应首先做到以下几点。 文档注释应能增加代码的可读性 编写注释的目的是使你、你的开发伙伴以及后续的开发人员更好地理解你的代码。SUN公司JAVA开发组的Nagle曾说过“如果程序不值得写文档的话，意味着代码也不值得运行”。 避免文档的过度修饰 六七十年代的COBOL语言开发着有一种注释习惯，通常用星号画一个方盒子来填写注释。这样做的确很好看，但对于最终产品来讲没有太多的益处。应当注意文档中注释和代码的比例，代码的注释应当简洁、明了。 在编码前就开始写文档 原则上讲，我们看一段代码总能发现它在做什么。例如，下面这段代码 中，我们能分析出代码的行为，但不能真正看出它的确切语义。 If ( grandTotal = 1000.00) { grandTotal = grandTotal*0.95; } 在注释文档中应说明代码所表达的语义和编码设计思想，而不应只是就事论事的讲述代码的行为。 如何使代码简洁 为代码写注释文档 将代码从逻辑上分段 合理的使用空行 遵守“30秒规则”，提高代码的可读性 书写较短的代码行 源文件的组织 一个JAVA源文件是由用空白行和注释分隔开的很多部分组成的