javadoc,javadoc注釋快捷鍵

本文目錄一覽：

• 1、JAVA中JAVADOC是什麼意思？
• 2、如何使用javadoc
• 3、如何使用javadoc命令生成api文檔，文檔注釋
• 4、JDK JavaDoc有什麼用

JAVA中JAVADOC是什麼意思？

javadoc就是通過源代碼(根據代碼類包等的關係加註釋)生成的api文檔，可以是html的網頁形式也可以打包成chm格式

如何使用javadoc

package com.frank.chapter1;

// object.Documentation1.java

// TIJ4 Chapter Object, Exercise 13 – 1

/* Run Documentation1.java, Documentation2.java and Documentation3.java

* through Javadoc. Verify the resulting documentation with your Web browser.

*/

/** A class comment */

public class Documentation1 {

/** A field comment */

public int i;

/** A method comment */

public void f() {

}

}

如上一段代碼，使用了javadoc的注釋形式，注釋以/** 開始, 以*/ 結尾，注釋寫在要說明部分的前面。

如何生成javadoc呢？ 很簡單，在eclipse中點擊導航欄中的 project-Generate javadoc 跳出如下界面，然後勾選需要生成文檔的包以及生成文檔的位置就OK啦！~

更詳細的說明見轉載

以下轉自：

通常我們寫java程序可能很少會寫注釋的，但是在公司里真正開發項目的時候。通常都會有嚴格的文檔要求，我這裡談到的不是設計或者測試文檔，而是javadoc。我一直認為javadoc察看起來比MSDN要方便，寫起來同樣不複雜。

javadoc是j2sdk裡面一個非常重要的工具，如果你按照規範在java的源代碼裡面寫好注釋的話，那麼它就可以生成相應的文

檔。開發者察看起來會非常方便。很多IDE都可以直接生成javadoc的，這裡介紹如何寫javadoc以及如何在eclipse下生成

javadoc。

javadoc通常從package、公開類或者介面、公開或者受保護的欄位、公開或者受保護的方法提取信息。每條注釋應該是以/**開始以*/結尾。例如

/**

*

* @param id the coreID of the person

* @param userName the name of the person

* you should use the constructor to create a person object

*/

public SecondClass(int id,String userName)

{

this.id = id;

this.userName = userName;

}

注釋應該寫在要說明部分的前面，如上所示。並且在其中可以包括html的標記，如果上面沒有標記

的話，那麼you should usr the ……將會在javadoc裡面緊跟@param userName….，這樣不是我們希望的。一般注釋可以分為類注釋、方法注釋、欄位注釋等。下面分別作簡單的介紹

類注釋

類注釋應該在import語句的後面在類聲明的前面，比如

package com.north.java;

/**

* @author ming

*

* this interface is to define a method print()

* you should implements this interface is you want to print the username

* @see com.north.ming.MainClass#main(String[])

*/

public interface DoSomething

{

/**

* @param name which will be printed

* @return nothing will be returned

*

*/

public void print(String name);

}

其中@author 和@see都是常用的注釋 第一個表示作者，第二個表示參考的連接。

2.方法注釋

方法注釋要緊靠方法的前面，你可以在其中使用@param @return @throws等標籤。例如

/**

*

* @param i

* @return true if ….. else false

* @throws IOException when reading the file ,if something wrong happened

* then the method will throws a IOException

*/

public boolean doMethod(int i) throws IOException

{

return true;

}

3.欄位注釋

只有public的欄位才需要注釋，通常是static德，例如

/**

* the static filed hello

*/

public static int hello = 1;

在eclipse中我們新建java

project然後編寫幾個介面和類以後就可以用javadoc生成文檔了，從菜單project選擇generate

javadoc，會出現一個嚮導，你按照他的提示一步一步的設定要求，最好他會問你是不是聲稱一個javadoc.xml，如果選擇生成的話，他會在

doc下產生一個javadoc.xml，以後更新文檔的時候你可以直接用ant運行javadoc.xml。選擇完成後你可以發現在project裡面

出現了一個目錄doc裡面就是你的javadoc,想寫出好的javadoc一個非常好的辦法就是多參考java的api

doc。養成一個好的編程習慣非常重要，何況這並不難。

如何使用javadoc命令生成api文檔，文檔注釋

使用javadoc命令生成api文檔：

創建java源文件包。java文件都是存放在一個package包中，這樣方便對java文件進行操作和區分，首先在磁碟上創建文件夾一樣的方式創建package包。

創建java源文件。在包下，創建與文件名相同的java源文件，輸入一些文檔注釋，這些文檔注釋用於自動的api文件進行說明使用。

進入java源文件目錄。通過cd等windows命令進入java源文件包所在的磁碟位置。

查看javadoc命令使用說明。如果是第一次使用javadoc命令，可以通過javadoc -help命令查看javadoc使用說明。

開始創建api文件。使用命令輸入javadoc -d javaapi -header 測試的API -doctitle 這是我的第一個文檔注釋 -version -author javadoc/Hello.java 進行文檔生成。-d:文件存儲位置; -head:文件頭部名稱; -version:顯示版本; -author:顯示作者; javadoc/Hello.java 處理的文件包以及java源文件。

查看生成的api文件。創建成功之後，就會自動創建指定的文件夾下生成api文件。打開index.html就是api文件的入口。

JDK JavaDoc有什麼用

JDK是一個工具包，裡面包括很多高級Java開發時需要用到程序庫和調試工具，比如虛擬機監控工具、內存工具、編碼工具、打包工具、文檔工具等等。其中的javadoc就是文檔工具，用來自動根據代碼中的帶有特定格式的注釋來生成HTML格式的文檔。典型的一個例子就是Java官網的API解釋。這些文檔就是根據Java源代碼中的注釋自動生成的。