java注释说明

   彩虹天堂，你人生中见到的彩虹是在哪个地方？

         代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面是我积累的关于写java代码注释的说明，供大家参考下。       

注释的条件：   

1、基本注释（必须加）

                            a.类，接口，抽象类注释

                            b.构造函数注释

                            c.方法注释

                            d.全局变量的注释

                            e.字段/属性注释

        

2、特殊必加注释（必须加）

(a)    典型算法必须有注释。

(b)    在代码不明晰处必须有注释。

(c)    在代码修改处加上修改标识的注释。

(d)    在循环和逻辑分支组成的代码中加注释。

(e)    为他人提供的接口必须加详细注释。

 举例说明：     

1.类注释

/**
* 类的描述
* @author Administrator
* @Time 2012-11-2014:49:01
*
*/
public classTest extends Button {
  ……

}

2.构造函数注释

 public class Test extends Button {
  /**
   * 构造方法 的描述
   * @param name
   *       按钮的上显示的文字
   */

  public Test(String name){
     ……
  }

}

3.方法注释

public class Test extends Button {
  /**
   * 为按钮添加颜色
   *@param color  按钮的颜色
   *@return
   *@exception  (方法有异常的话加)
   *@author Administrator
   *@Time2012-11-20 15:02:29
   */
  public voidaddColor(String color){

     ……

  }

}

4.全局变量注释，字段/属性注释

public final class String implements java.io.Serializable, Comparable<String>,CharSequence

{

   /** The value is used for characterstorage. */

   private final char value[];

   /** The offset is the first index of thestorage that is used. */

   private final int offset;

   /** The count is the number of charactersin the String. */

   private final int count;

   /** Cache the hash code for the string */

   private int hash; // Default to 0

   ……

}

****在eclipse中添加注释说明

在使用Eclipse 编写Java代码时，自动生成的注释信息都是按照预先设置好的格式生成的。

修改作者、日期注释格式：打开Windows->Preferences->Java->CodeStyle->CodeTemplates，点击右边窗口中的Comments，可以看到有很多选项，我们便可对此注释信息模板进行编辑

以下说几个重点的模板：

1.文件注释（也就是包名注释，在创建该类的时候勾选generate comments，默认不勾选的)

Files：

/**
 * <p>Title: ${file_name}</p>
 * <p>Description: </p>
 * <p>Copyright: Copyright (c) 写你公司版权信息</p>
 * <p>Company: 写你公司的名称</p>
 * @author 写你自己的名字
 * @date ${date}
 * @version 写自己的版本信息
 */

2.类，接口，抽象类模板

Types:

/**
 * <p>Title: ${type_name}</p>
 * <p>Description: </p>
 * <p>Company: 写你自己的公司名称<p> 
 * @author 写你自己的名字
 * @date ${date}
 */

3.构造函数注释

Constroctors：

/**
 * <p>Title: </p>
 * <p>Description: </p>
 * ${tags}
 */

4.方法注释

/**
 * <p>Title: ${enclosing_method}</p>
 * <p>Description: </p>
 * ${tags}
 */

5.重载方法注释

/** （非 Javadoc）
 * <p>Title: ${enclosing_method}</p>
 * <p>Description: </p>
 * ${tags}
 * ${see_to_overridden}
 */