1.配置好Java環境變量,
2.編寫好一個Java程序,OK,準備工作已完成。
我的測試類文件保存在 C:\Users\90383\Desktop\JavadocTest 文件夾下,內容如下:
/**
* 測試類
*/
public class Test2 {
/**
* 變量
*/
public String str;
/**
* 構造器
*
*/
public Test2() {
}
/**
* 程序入口
* @param args 入參
*/
public static void main(String[] args) {
}
/**
* 測試方法
* @param str 入參
* @return 返回數據
*/
public String method1(String str){
return "我日";
}
}
打開cmd交互框:切換到所在文件夾,
cd C:\Users\90383\Desktop\JavadocTest
使用Javadoc生成API文檔的關鍵命令如下:
javadoc -d apidoc -windowtitle 測試 -doctitle 學習 javadoc 工具的測試API文檔 -header 我餓header *.java -encoding utf-8 -charset utf-8
如此,就完成了API文檔的生成,內容和樣式如下: