在Eclipse中怎樣寫Java注釋

java中的注釋分為實現注釋和文檔注釋

實現注釋就是那些/……../和//……的注釋，是注釋程序用的，文檔注釋是/*……./的注釋，是用來生成javadoc的。設置方法如下：
1.打開Eclipse的偏好設置：



2.依次選擇Java > Code Style > Code Template > Comments:



一、文件注釋

文件頭注釋以 /開始，以/結束，其中列出類名，版本信息，日期和版權聲明。
選擇comments下的Files，點擊Edit進行編輯：



/*
* ${file_name}
* Version 1.0.0
* Created on ${date}
* Copyright QuickCodes.net
*
*/

 

設置好了之后，你新建類的時候ec就會自動幫你生成文件注釋了。

二、類、接口注釋

類、接口注釋/*開始，以/結束,作為類或接口的介紹信息出現在生成的javadoc中。一般寫成下面這樣。

 

/**
 * @author ${user}
 * @version 1.0.0
 * @since 
 * ${tags}
 * 創建時間：${date}
 * 功能描述：
 * 官方網站：www.QuickCodes.net
 * 郵箱地址：[e-mail]
 */

 

使用方法：
新建一個類后，在類聲明的地方輸入“/**”：



回車后自動生成如下注釋：



在上面的例子中，@author、@version和@see是標記。標簽分為塊標簽（block tag）和內聯標簽（inline tag）。塊標簽直接@tag來用，內聯標簽是{@tag}來用的。下面介紹幾個常用的塊標簽

@author

用在類注釋中，表示作者。函數注釋里面可以不出現@author。

@version

用在類注釋中，表示版本信息。函數注釋里面可以不出現@version。

@since

用在類注釋中，標明該類可以運行的JDK版本

@param標記

@param標記后跟的是方法的參數名，注意不是參數類型。

@return標記

@return后跟的是方法的返回值類型。返回為空（void）的構造函數或者函數，@return可以省略。

關於注釋標簽的詳細信息可以看http://java.sun.com/j2se/javadoc/writingdoccomments/#tag

三、屬性注釋（field）

可以是實現注釋也可以是文檔注釋，如果是文檔注釋，會在javadoc中出現，比如



/** 用戶ID */
private Integer userID;

/** 用戶名 */
private String userName;

 

四、方法注釋

方法注釋采用 /** … */，描述部分注明方法的功能，塊標記部分注明方法的參數，返回值，異常等信息



/**
     * 
     * @param userName
     * @param password
     * @return
     */
    public String doLogin(String userName,String password){
        return "loginsuccess";
    }

 

關於java的注釋規范可以詳見http://java.sun.com/j2se/javadoc/writingdoccomments/