标签:
  * 尽量使用完整的英文描述符 
  * 采用适用于相关领域的术语 
  * 采用大小写混合使名字可读 
  * 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一 
  * 避免使用长的名字(小于 15 个字母是个好主意) 类似的名字,或者仅仅是大小写不同的名字 
  * 避免使用下划线(除静态常量等)
  * 包(Package) 采用完整的英文描述符,应该都是由小写字母组成。对于全局包,将你的 Internet 域名反转并接上包名。 如: 
      java.awt 
     com.ambysoft.www.persistence 
  * 类(Class) 采用完整的英文描述符,所有单词的第一个字母大写。 如: 
      Customer 
     SavingsAccount 
  * 接口(Interface) 采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able, ible 或者 er,但这不是必需的。如: 
      Contactable 
     Prompter 
  * 组件/部件(Component) 使用完整的英文描述来说明组件的用途,末端应接上组件类型。 如: 
      okButton 
      customerList 
      fileMenu 
  * 异常(Exception) 通常采用字母 e 表示异常。 e 
  * 类变量 字段采用完整的英文描述,第一个字母小写,任何中间单词的首字大写,如:   firstName 
      lastName 
  * 实参/参数 同字段/属性的命名规则 
      public void setFirstName(String firstName){ 
            this.firstName = firstName; 
     } 
  * 局部变量 同字段/属性的命名规则 
  ** 获取成员函数 被访问字段名的前面加上前缀 get。 getFirstName(), getLastName() 
    ** 布尔型的获取成员函数 所有的布尔型获取函数必须用单词 is 做前缀。 isPersistent(), isString() 
    ** 设置成员函数 被访问字段名的前面加上前缀 set。 setFirstName(), setLastName(),setWarpSpeed() 
    ** 普通成员函数 采用完整的英文描述说明成员函数功能,第一个单词尽可能采用一个生动的动词,第一个字母小写。 openFile(), addAccount() 
    * 静态常量字段(static final) 全部采用大写字母,单词之间用下划线分隔。 MIN_BALANCE, DEFAULT_DATE 
    
    * 循环计数器 通常采用字母 i,j,k 或者 counter 都可以接受。 i, j, k, counter 
    * 数组 数组应该总是用下面的方式来命名: byte[] buffer;
  * 注释应该增加代码的清晰度 
  * 保持注释的简洁 
  * 在写代码之前写注释 
  * 注释出为什么做了一些事,而不仅仅是做了什么 
所有的 Java(*.java) 文件都必须遵守如下的样式规则: 
  1) 版权信息 
  版权信息必须在 java 文件的开头,比如: 
  /** 
    * Copyright @ 2000 Shanghai XXX Co. Ltd. 
    * All right reserved. 
    * @author: gcgmh 
    * date: 2008-12-22 
    */ 
  其他不需要出现在 javadoc 的信息也可以包含在这里。 
  2) Package/Imports 
  package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。 
  package hotlava.net.stats; 
    
     import java.io.*; 
     import java.util.Observable; 
     import hotlava.util.Application; 
  这里 java.io.* 是用来代替InputStream and OutputStream 的。 
  3) Class 
  接下来的是类的注释,一般是用来解释类的。 
  /** 
   * 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{ 
        …… 
         …… 
    } 
   
   4) Class Fields 
  接下来是类的成员变量: 
  /** 
    * Packet counters 
    */ 
    protected int[] packets; 
  public的成员变量必须生成文档(JavaDoc)。proceted、private和 package 定义的成员变量如果名字含义明确的话,可以没有注释。 
  5) 存取方法(类的设置与获取成员函数) 
  接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话,可以简单的写在一行上,如类的成员变量已经有注释,类变量的存取方法可以没有注释。 
  public int[] getPackets() { return this.packets; } 
   public void setPackets(int[] packets) { this.packets = packets; }  
     …… 
  要求说明的是,对于集合,加入成员函数来插入和删除项;另其它的方法不要写在一行上。 
  6) 构造函数 
  接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。 
  public CounterSet(int size){ this.size = size;} 
  7) 克隆方法 
  如果这个类是可以被克隆的,那么下一步就是 clone 方法: 
  public Object clone() { try { …… }catch(CloneNotSupportedException e) { …… }} 
  8) 类方法 (类的普通成员函数) 
  下面开始写类的方法: 
  /** 
   * Set the packet counters 
   * param r1 - …… 
   * param r2 - …… 
   * …… 
   */ 
  protected final void setArray(int[] r1, int[] r2, int[] r3, int[] r4) throws IllegalArgumentException{ 
   // Ensure the arrays are of equal size 
   …… 
  } 
9) toString 方法 
  一般情况下,每一个类都应该定义 toString 方法: 
  public String toString() { ……} 
  10) main 方法 
  普通类,考虑置入一个main()方法,其中包含用于测试那个类的代码,如果包含了main() 方法, 那么它应该写在类的底部。
标签:
原文地址:http://www.cnblogs.com/vrfighter/p/5901672.html