myeclipse的javadoc 簡單設定

1.當我們建立一個類或者方法時，很多時候需要寫注釋，比如作者，日期等，每次寫都比較麻煩。此時，我們可以利用myeclipse的自動生成注釋的功能。

window → preferences → Java → CodeStyle → Code Templates

①Code → New Java files → Editor → 類或接口的。加入下面的内容

${filecomment}

${package_declaration}

/***********************

* @author han    

* @version 1.0        

* @created ${date}    

***********************

*/

${typecomment}

${type_declaration}

②Comments → Methods → Editor → 方法名的注釋

/** *******************

* ${tags}

* ${date}

* @author han

* *******************

這樣當你建立一個類或接口，或者建立一個方法時，就會主動的加上上面的一些注釋。

package com.hanchao.application;

* @created 2013-6-21    

public class Demo5 {

/**

* ********************

* @param args

* 2013-6-21

* @author  han

*********************

public static void main(String[] args) {

}

* @param arg1

* @param arg2

* @param arg3

* @return

* @author： han

public String method1(String arg1,String arg2,String arg3) {

return null;

　　如何規範生成JAVADOC幫助文檔

　　1.文本注釋（/** */）也叫歸檔注釋。

　　歸檔注釋是一種專用注釋；當它放在類或類成員聲明之前時，javadoc工具可以提取出這些注釋并用它們來生成程式的HTML文檔。歸檔注釋通常入在類、接口、方法及字段定義之前。

　　2.文本注釋中的“文檔标記”（Doc tags）是一些以“@”開頭的指令;

　　3.javadoc隻能為public（公共）和protected（受保護）成員處理注釋文檔。“private”（私有）和“友好”成員（即沒有通路控制符）的注釋會被忽略，我們看不到任何輸出（也可以用-private标記包括private成員）。

　　4.類文檔标記

　　類文檔可以包括用于版本資訊以及作者姓名的标記。

　　（1）@version

　　格式如下：

　　@version 版本資訊

　　其中，“版本資訊”代表任何适合作為版本說明的資料。若在javadoc指令行使用了“-version”标記，就會從生成的HTML文檔裡提取出版本資訊。

　　（2） @author

　　@author 作者資訊

　　其中，“作者資訊”包括您的姓名、電子函件位址或者其他任何适宜的資料。若在javadoc指令行使用了“-author”标記，就會專門從生成的HTML文檔裡提取出作者資訊。

　　可為一系列作者使用多個這樣的标記，但它們必須連續放置。全部作者資訊會一起存入最終HTML代碼的單獨一個段落裡。

　　--------------------------------------

　　方法文檔标記

　　方法允許使用針對參數、傳回值以及異常的文檔标記。

　　（1）@param

　　@param 參數名 說明

　　其中，“參數名”是指參數清單内的辨別符，而“說明”代表一些可延續到後續行内的說明文字。一旦遇到一個新文檔标記，就認為前一個說明結束。可使用任意數量的說明，每個參數一個。

　　（2）@return

　　@return 說明

　　其中，“說明”是指傳回值的含義。它可延續到後面的行内。

　　（3）@exception

　　有關“違例”（Exception）的詳細情況，

　　@exception 完整類名 說明

　　“完整類名”明确指定了一個違例類的名字，它是在其他某個地方定義好的。

　　而“說明”（同樣可以延續到下面的行）告訴我們為什麼這種特殊類型的違例會在方法調用中出現。

　　（4） @deprecated該标記的作用是建議使用者不必再使用一種特定的功能，因為未來改版時可能摒棄。

　　若将一個方法标記為@deprecated，則使用該方法時會收到編譯器的警告。

　　順便提一下在eclipse下，當滑鼠處于類，方法定義行時，按Alt+Shift+J，就可以快速添加文檔注釋。至于如何導出javadoc文檔，eclipse環境下，file > export > javadoc > 這裡隻要選中你要導出的*.java檔案即可，要十分注意的是，通常很多人的classpath環境下，帶有 %classpath% 這使javadoc指令無法正确地執行。而提示的出錯資訊通常是IlleagalArgumentException。

JavaDoc标記：

@version  指定版本資訊

@since     指定最早出現在那個版本中

@author   指定作者

@see        生成參考其JavaDoc文檔的連結

@link         生成參考其JavaDoc文檔的連結，差別在于，它能夠嵌入到注釋語句中，為特定的詞彙生成連結

@deprecated   辨別被注釋的類、變量、方法不被提倡

@param    描述方法的參數

@return    描述方法的傳回值

@throws   描述方法抛出的異常

由于@created不被識别。是以把${date}放在@version的後面

* @version 1.0 ${date}          

* @author liweiHan (${user}@sohu-inc.com)

* @version 1.0 (${date} ${time})

方法 ： 

 * ${tags} ${return_type}

 *

 * ${date} ${time}

 * ${user}

 */

     本文轉自韓立偉 51CTO部落格，原文連結：http://blog.51cto.com/hanchaohan/1226522，如需轉載請自行聯系原作者