[通用java代码规范.doc

目的 编程领域有很多种语言，如C， Java， VB， Pascal，他们就像我们现实生活中的汉语、英语、西班牙语、法语一样，相互之间跨度比较大，一段由某语言开发的程序由不了解该门语言的人看起来会比较困难。但如果大家都使用同一种开发语言，相互交流起来会很轻松吗？答案是不会的，因为每个程序员都是很有个性的人，彼此的风格习惯不一致，就好像虽然大家都用汉语，一个讲广东话，一个讲四川话，沟通起来还是有些费力的，这时候，我们就非常需要普通话了。 编程规范就是语言的普通话标准，它使程序员用一种声音讲话，可以更有效的传递信息，降低沟通的成本。 ? ? Java基本概念 名称 修饰符 说明 Java有三种修饰符 Public protected private， 还有一种叫缺省类型，既对一个属性或方法什么修饰符也没有声明 public 声明的属性和方法可以被任何类使用 缺省类型 声明的属性和方法可以被同一个包内的类使用 protected 声明的属性和方法可以被同一个包内的类使用，还可以被这个类自身的子类使用 private 声明的属性和方法只能在这个类内部使用 示例 Class A{ public void getName(){}; private void doGoodJob(){}; protected void save(){}; void orderBook(); } ? ? 名称 Javadoc 说明 标签 适用于 目的 @author 接口 类 程序的编写者 @deprecated 接口 类 类的方法 声明某个类，某个接口，或某个方法将来会不再使用 @exception 类的方法 描述这个方法将要抛出的异常 @param 类的方法 描述传入这个方法的参数 @return 类的方法 描述这个方法将要返回的值的类型 @since 接口 类 类的方法 描述这个项是什么时候开始出现的,例如 @since JDK1.4.1 @see 接口 类 类的方法 类的属性 将会产生一个hypertext连接到指定的Class。接口，类的方法或属性。 @version 接口 类 指定这个源码的版本号 示例 ? /** * Compares this object against the specified object. * The result is codetrue/code if and only if the argument is * not codenull/code and is a codeBitset/code object that has * exactly the same set of bits set to codetrue/code as this bit * set. That is, for every nonnegative codeint/code index codek/code, * pre((BitSet)obj).get(k) == this.get(k)/pre * must be true. The current sizes of the two bit sets are not compared. * pOverrides the codeequals/code method of codeObject/code. * * @param obj the object to compare with. * @return codetrue/code if the objects are the same; * codefalse/code otherwise. * @see java.util.BitSet#size() */ public boolean equals(Object obj) { //…… } ? ? ? 名称 如何取一个好名字 说明 尽量使用英文单词全称表示类和变量，如果名称过长（大于15个单词）可以使用简称。 使用首字母大写，其他字母小写的一组单词增加可读性(对于方法名或变量名的定义第一个单词的首字母要小写) 如果要使用单词的简称，哪必须在所有文档中全部保持一致 尽量避免一个字符长度大于15个字母的名称 避免在同一份文档内声明的两个十分相似的名字 对标准缩写看作它是一个单词的方式，而不是全部使用大写 示例 Good Name Bad Name ManageFeePercent ManaGEF