学士后java冲刺项目编码规范_v10..doc

Java源代码书写规范 说明 本文档约定了Java程序员应该共同遵守的源代码写书风格及一般规则，定义这个规范的目的是让项目中所有的代码和文档看起来都像一个人写的，增加可读性，减少项目组中因为换人而带来的损失，并为未来的维护打好基础。 本文档的描述以JAVA为基础。 本文档包含了开发环境中代码书写需要注意的问题，但并不是全部。未包含在内的部分应遵循一般的习惯及标准，或及时提出由小组内讨论并加以统一。 目录 说明 0 1命名 1 1.1命名规则 1 1.2变量的初始化及使用 1 2文件样式 1 2.1版权信息 1 2.2 package语句 1 2.3 import语句 1 2.4类注释和类 2 2.5成员注释和成员 2 2.6存取方法 2 2.7构造方法 3 2.8方法注释和方法 4 2.9 main 方法 4 2.10语句 4 3需要重视的问题 5 附：Java编程规范 5 1命名 1.1命名规则 package命名：包名应该都是由小写单词组成。示例：org.gongxue.one.crm.admin，必须以org.gongxue开头,后面可以跟小组名称，跟项目类型及模块名称等。 class命名：类名必须由大写字母开头，后面单词的首字母都要大写。如PolicyParser。 变量的命名：变量名必须用一个小写字母开头，后面单词的首字母都要大写，并指出完整的含义。如serverList。如果长度过长，可以适当的采用缩写字母，但其缩写一定要清晰易读。如domainUserPWD static final 命名：静态不变量的名字所有字母都要大写。如SERVERNUMBERS 数组的命名：数组命名使用类型后接着[] 然后是名字，该名字要符合变量的命名规范。如byte[] buffer 函数名的命名：与变量的命名规范一致，往往含有动作单词。 参数的命名：与变量的命名规范一致。 临时变量的命名：规则与变量的命名相同，但是以t开头。如tUserPWD 1.2变量的初始化及使用 除特殊情况，所有变量（尤其局部变量）在定义时都应赋予相应类型的初始值。主数据类型中Boolean类型为false;数值类型为0；Char类型为null。对象类型为null(数组也是对象)。 返回的对象类型在使用前应检查是否为null 对内存使用有要求的程序，在使用对象后应赋予null值。 2文件样式 2.1版权信息 版权信息必须在java文件的开头。如 /** * Copyright ? 2012 gongxue Co，Ltd. * All right reserved. */ 其他不需要出现在 javadoc 的信息也可以包含在这里 2.2 package语句 package语句必须作为文件的第一个非注释语句出现，指出这个编译单元属于哪一个库。 如：package mypack; 2.3 import语句 import语句载入包内的类。标准的包名要在本地的包名前，而且按照字母顺序排列，如果import行中包含了一个包中不同的类，用*代替多个类。 如： import java.net.*; import java.util.Vector; import org.gongxue.one.crm.admin.*; import org.gongxue.one.crm.bll.*; 2.4类注释和类 一个类注释恰好位于一个类定义之前，解释类的功能。 如：/** * A class representing a set of packet and byte counters * It is observable to allow it to be watched, but only * reports changes when the current set is complete */ 类注释接下来是类定义，包含了在不同的行的 extends 和 implements。语句写不下，折行时，缩进两列。 public class CounterSet extends Observable implements Cloneable{ ………… } 2.5成员注释和成员 一个成员注释恰好位于一个成员定义之前，解释成员的含义。 如： /** * Packet counters */ public，proceted 的成员变量必须使用该种注释，private成员变量可以用// 如果成员是集合类型，必须说明容纳的对象类型。 成员定义如下： protected int[] packets; 成员命名符合变量命名规则。 2.6存取方法 接下来是类变量的存取的方法。它只是简单的用来进行类的成员变量赋值和获取值，可以简 单的