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文档的生成,内容和样式如下: