1. 程式人生 > >JAVA如何在eclipose中生成幫助文檔

JAVA如何在eclipose中生成幫助文檔

路徑 註釋 nis 一個 html pos 幫助 src etag

JAVA中註釋有三種 1 單行註釋 //+內容 2 多行註釋 /* 內容 */ 3 文檔註釋 /**內容*/

其中單行註釋和多行註釋是用於方法裏面的註釋 ,文檔註釋是用來註釋類的成員和方法。

幫助文件是用多行註釋實現的,用的程序是JAVA中jdk目錄下bin目錄JAVAdoc.exe。

首先 打開eclipose,找到一個需要生成幫助文檔的工程。工程裏面的類都是用多行註釋標記了方法和屬性的。比如

package java4_10;
/**
 * 
 * @author 我
 *
 */
public class DEpt {
private int age;
public String name;
public String master; /** * 修改器,可以完成私有屬性的修改 * @param age 年齡 */ public void setAge(int age){ this.age = age; } /** * 訪問器,可以得到私有屬性的值 * @return 年齡 */ public int getAge(){ return this.age; } public void setName(String name){ this.name = name; } public String getName(){ return this.name; } }

然後在工程上點擊右鍵找到 Export選項,在如下對話框依次選擇 java—————javadoc

技術分享圖片

雙擊javadoc跳轉如下對話框

技術分享圖片

在Destination下選擇要生成的幫助文件保存位置

選擇Java中javadoc.exe程序路徑 單擊finish就自動生成幫助文件

然後在你保存幫助文件的地方就有了如下文件

技術分享圖片

然後點擊index.html選擇你想要查看的包的類,就可以查看幫助文檔了

JAVA如何在eclipose中生成幫助文檔