JAVA程序编写细则.docVIP

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语言的项目。 裁剪指南 无。 资源和工具 引用标准： Capability Maturity Model? Integration (CMMISM), Version 1.1 工具： Microsoft Word Microsoft Excel Microsoft Visio SubVersion 定义和缩写 无。 职责 无。 指南/规范 命名规范 Package 的命名Package 的名字应该都是由一个小写单词组成。Class 的命名Class 变量的命名变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。ecRecord(RecRecordData data); 参数的命名参数的名字必须和变量的命名规范一致。数组的命名数组应该总是用下面的方式来命名： byte[] ; 方法的参数使用有意义的参数命名，如使用和要赋值的字段一样的名字：SetCounter(int size){ this.size = size; } SetCounter(int newSize){ this.size = newSize; } 文件样式 所有java文件都必须遵守以下样式规则： 类的全局变量必须注释。建议：函数体内的重要变量也需要注释。 函数说明必须有，且符合JAVA的标准。可被JAVADOC识别。必须包括的项目有：函数意义、参数、返回值、自定义异常、及其它重要事项。 类的注释：作者、类的意义、用法、及注意事项（如某些资源的释放）。 函数体内部也应有适当注释。所有注释不低于25%。 Class 接下来的是类的注释，一般是用来解释类的。/** * pTitle: 类功能的一句话描述/p * pDescription: 类功能及实现方法的描述/p * pCopyright: Copyright (c) 2004/p * pCompany: /p * @author 作者 * @version 1.0 */ 接下来是类定义 public class CounterSet extends Observable implements Cloneable Class Fields 接下来是类的成员变量：/** * Packet counters */ protected int[] packets; public 的成员变量必须。存取方法接下来是类变量的存取的方法。/** * 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); } 构造函数接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。访问类型(public, private 等)和任何 static, final 或 synchronized应该在一行中，并且方法和参数另写一行，这样可以使方法和参数更易读。 Public CounterSet(int size){ this.size = size; } 克隆方法如果这个类是可以被克隆的，那么下一步就是 clone 方法：Public Object clone() { try { 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()); } } 类方法下面开始写类的方法： /** * Set the