Java代书写规范.docVIP

Java代码书写规范 2003/04/15 当不得不违背本规范时，请详细注释原因 一、通用规范 1.1命名规范 使用全单词表示 使用贴切的词汇 使用大,,,,写混合 尽量少用缩略词，否则，维护一个标准的缩略词表 避免过长，,,,,于15 避免类似的命名或仅在大,,,,写上区分的命名 标准缩略词做一个单词处理 1.2文档规范 增加注释，以确保代码清晰 无需注释的程序，可能也不值得运行 避免修饰性注释 保持注释简洁 写代码之前写注释 注释中说明代码的原因，而不是结果 二、Java编码规范 2.1命名和大,,,,写规范： 下面这些广泛使用的命名规范可以应用到Java中的包、类、方法、属性和常量。因为这些规范的使用非常普遍，而且它们还影响到了我们定义的类的公共API，所以我们应该认真遵守这些规范： 包 保证包的名称是唯一的，包的名称前缀以我们的网络域名称，包名,,,,写（例如com.itsv.utils）置于文件最上一行 类 第一个字母必须大写，所以类名称是大,,,,写混合的（例如String）；如果类名称是由多个单词组成的，那么每个单词都应该以大写字母开头（例如StringBuffer）；如果一个类名称或者类名称中的一个单词是字母缩写词，那么我们可以把这个缩写词中的每个字母都写成大写（例如URL、HTMLParser）。因为设计的类是用来代表对象的，所以我们在为类起名称时应尽量选择名词。 如果是某一种特殊类别的类，则可以统一采用特殊简短后缀来标识，这些后缀全部大写。例如，对所有处理与数据库相关的类，可以在类名后加上DAOImpl来标识 引用类： 全部置于包名之后，文件所定义类名之前 类的定义顺序： class xxx constructors finalize public member functions protected member functions private member functions private fields 接口 接口名称遵循的大,,,,写规则和类名称是一样的。用接口来提供一些关于实现它的类的额外信息，常用形容词作为接口名称（例如Runnable），当接口更像一个抽象的超类时，我们又用名词来作为接口的名称（例如Document） 在创建类之前先创建公共接口，以确定类的应用存根，接口的命名用描述性的形容词或名词，或者加前缀I 或后缀Ifc： Runnable Cloneable Singleton DataInput 方法 方法名称总是以,,,,写字母开头。如果名称中包含的单词多于一个（一般使用动词和名词组合而成），那么除第一个单词外的所有单词都应该以大写字母开头，动词放在首单词，例如insert（）、insertObject（）。 成员变量访问方法accessor的命名： 使用Getter-get和Setter-set方法，对于boolean类型的可以使用is代替get Getter还有can和has 成员方法的范围： 范围 描述 正确使用方法 Public 任何类或对象的任何成员方法中可以调用 当该方法必须被当前类分支之外的类或对象调用时 Protected 只能被同类及所有子类的成员方法调用 当该方法只能被当前类及其分支之内的类或对象调用时 private 只能被同类的成员方法调用，子类的成员方法不能调用 封装一个类的特有方法，当前类所特有，其他类或子类没有 缺省的为软件包级可用，对相同软件包package的类可使用，不能在不同软件包的类中调用 属性和常量 非常量的属性名称所遵循的大,,,,写规则和方法名称是一样的。如果一个属性是静态final类型的常量，那么该属性的所有字母都应该大写。如果常量的名称中包含多个单词，那么应该用下划线来分隔这些单词（例如MAX_VALUE）。此外，选择的属性名称应该是最能说明属性或其取值的含义的。 集合属性(Array, Vector)采用复数 firstName orderItems 常量命名 static final MAX_VALUE 属性范围 范围 描述 用于 public 可以在所有类的方法中引用 最好不定义此类属性 protected 可以在本类及子类方法中引用 最好不定义此类属性 private 只能用于同类的方法中 所有属性都应是此种类型并通过访问器accessor访问 参数 方法参数名称会出现在方法的文档中，所以参数含义应尽可能明确。一般参数名称为一个单词。 成员函数的参数标准： 使用接口代替类作为参数，实现多态性 局部变量 命名规则和方法以及属性的命名规则一样。 2.2 注释规范 2.2.1总体说明 三种类型的Java注释 注释类型 用于 例子 文档注释 写在类、接口、成员函数和属性的