JAVA程序编写规范.doc

JAVA 程序编写规范程序编写规范 目 录 1目的目的1 2适用范围适用范围1 3裁剪指南裁剪指南1 4资源和工具资源和工具1 5定义和缩写定义和缩写1 6职责职责1 7指南指南/规范规范.2 7.1命名规范2 7.2文件样式3 7.3代码编写格式5 7.4命名约定（建议）6 7.5其它规范6 8记录记录7 JAVA 程序编写规范 - 0 - 1 目的目的 为了保证程序代码的质量，提高程序的可靠性、可读性和一致性，特制定 本规范。 2 适用范围适用范围 本规范适用于公司所有使用 JAVA 语言的项目。 3 裁剪指南裁剪指南 无。 4 资源和工具资源和工具 引用标准： Capability Maturity Model Integration (CMMISM), Version 1.1 工具： Microsoft Word Microsoft Excel Microsoft Visio SubVersion 5 定义和缩写定义和缩写 无。 6 职责职责 无。 JAVA 程序编写规范 - 1 - 7 指南指南/规范规范 7.1 命名规范命名规范 （1） Package 的命名 Package 的名字应该都是由一个小写单词组成。 package net.htjs.nssb.yhgl.person; （2） Class 的命名 类名的开头为大写字母，多单词组合时，每个单词头字母大写。 class DocFlow （3） Class 变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。 String userName; （4） Class 函数的命名 函数的名字必须用一个小写字母开头。后面的单词用大写字母开头。 如 void addRecRecord(RecRecordData data); （5） 参数的命名 参数的名字必须和变量的命名规范一致。 userName, String userPass); （6） 数组的命名 数组应该总是用下面的方式来命名： byte names; （7） 方法的参数 使用有意义的参数命名，如使用和要赋值的字段一样的名字或相关的 名字： SetCounter(int size) this.size = size; JAVA 程序编写规范 - 2 - SetCounter(int newSize) this.size = newSize; 7.2 文件样式文件样式 所有 java 文件都必须遵守以下样式规则： （1） 类的全局变量必须注释。建议：函数体内的重要变量也需要注释。 （2） 函数说明必须有，且符合 JAVA 的标准。可被 JAVADOC 识别。必 须包括的项目有：函数意义、参数、返回值、自定义异常、及其它 重要事项。 （3） 类的注释：作者、类的意义、用法、及注意事项（如某些资源的释 放） 。 （4） 函数体内部也应有适当注释。所有注释不低于 25%。 （5） Class （6） 接下来的是类的注释，一般是用来解释类的。采用开发工具 IDE 自 动生成注释框架 /* * Title: 类功能的一句话描述 * Description: 类功能及实现方法的描述 * Copyright: Copyright (c) 2004 * Company: * author 作者 * version 1.0 */ （7） 接下来是类定义 public class CounterSet extends Observable implements Cloneable JAVA 程序编写规范 - 3 - （8） Class Fields 接下来是类的成员变量： /* * Packet counters */ protected int packets; （9） public 的成员变量必须采用上例的注释格式。 （10） 存取方法 接下来是类变量的存取的方法。 /* * Get the counters * return an array containing the statistical data. This array has been * freshly allocated and can be modified by the caller. */ public int getPackets() return copyArray(packets, offset); （11） 构造函数 接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后 面）。访问类型(“public“, “private“ 等)和任何 “static“, “final“ 或 “synchronized“应该在一行中，并且方法和参数另写一行，这样可以使方法 和参数更易读。 Public CounterSet(int size) this.size = size; （12） 克隆方法 如果这个类是可以被克隆的，那么下一步就是 clone 方法： Public Object clone() try JAVA 程序编写规范 - 4 - CounterSet obj = (CounterSet)super.clone(); obj.packets = (int)packets.clone(); obj.size = size; return obj; catch(CloneNotSupportedException e) throw new InternalError(“Unexpected CloneNotSUpportedException: “ + e.getMessage(); （13） 类方法 下面开始写类的方法： /* * Set the packet counters * (such as when restoring from a database) */ protected final void setArray(int r1, int r2, int r3, int r4) throws IllegalArgumentException / / Ensure the arrays are of equal size / if (r1.length != r2.length | r1.length != r3.length | r1.length != r4.length) throw new IllegalArgumentException(“Arrays must be of the same size“); System.arraycopy(r1, 0, r3, 0, r1.length); System.arraycopy(r2, 0, r4, 0, r1.length); JAVA 程序编写规范 - 5 - （14） main 方法 如果 main(String) 方法已经定义了, 那么它应该写在类的底部.。 7.3 代码编写格式代码编写格式 （1） 文档化 必须用 javadoc 来为类生成文档。不仅因为它是标准，这也是被各种 java 编译器都认可的方法。 （2） 缩进 缩进应该是每行 2 个空格. 不要在源文件中保存 Tab 字符. （3） 对 中的语句应该单独作为一行。 if (i0) i + ; 7.4 命名约定（建议）命名约定（建议） （1） 数据映射类： 文件的结尾为 Data，如上报信息映射类：reportData.java。 （2） 数据操作类 文件的结尾为 Imp，如对上报信息进行操作的类：reportImp.java。 增加方法：add* 删除方法：del* 修改方法：modify* 查询方法：find* （3） 控制类 Servlet 类都作为控制类，文件结尾为 Ctrl，如 reportCtrl.java。 JAVA 程序编写规范 - 6 - 7.5 其它规范其它规范 （1） 建议：对于两个字符串相加的情况（次数较多时，特别是使用循环 追加字符串的情况），必须使用 StringBuffer 类的 append 方法。 （2） JAVA 开发工具：Eclipse、Idea 系列。 （3） 建议：WEB 应用服务器：WebLogic、Tom