javadoc

最近研究了一下javadoc的使用，主要是使用eclipse來生成文檔

一直以來，我只知道這是用來替code做註解，不過不太懂究竟是怎樣用

今天剛好看到書介紹，終於有了一些了解，原來他主要是在網頁上做呈現

而javadoc最主要的用處是開發者再開發軟體時，總會替自己的code做註解

當program較為龐大時，為了讓軟體更好維護，會另外再做一個較清楚文件

Eclipse中生成javadoc檔有三種方式:
(1)在該項目上點擊右鍵-->Export-->java-->javadoc
便會出現對話框，Javadoc command 選擇 jdk/bin/javadoc.exe
按下finish即可產生文檔

(2)直接從file-->Export
步驟同(1)

(3)從工作列 project-->generate javadoc
直接出現對話框

便會在該program的目錄下出現doc資料夾，就可以看到使用javadoc所產生的網頁


例子如下:

public class Test {
/**
*
* @author chen
*
*/
interface operator{
/**
*
* @param a
* @param b
* @return
*/
int operate(int a, int b);
}

public int print(int a , int b , operator op){
return op.operate(a, b);
}
public static void main(String[] args) {
// TODO Auto-generated method stub
Test test = new Test();
operator add = (a , b)->a+b;
operator sub = (a , b)->a-b;
System.out.println(test.print(40, 20, add));
System.out.println(test.print(40, 20, sub));
}

}

這就是javadoc所產生的樣子