JAVADOC命令生成注释文档API

最新推荐文章于 2025-06-25 10:53:24 发布

原创最新推荐文章于 2025-06-25 10:53:24 发布 · 5.2k 阅读

1 ·

CC 4.0 BY-SA版权

JAVA学习专栏收录该内容

30 篇文章

订阅专栏

本文档介绍了如何使用JAVADOC命令来生成API文档。通过执行'javadoc -help'获取详细参数和帮助信息。利用-d选项指定apidoc_directory作为输出目录，-windowtitle和-doctitle分别定义窗口标题和文档标题，-header添加自定义头部信息，同时启用-author和-version选项，展示作者和版本信息，最后指定源文件如*.java进行文档生成。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

输入javadoc -help 查看命令具体参数和帮助

javadoc -d apidoc_directory -windowtitle 测试 -doctitle JAVADOC生成测试文档API -header 小爷的所有类 -author -version *.java

//test1.java
package TEST1;
/**
**********************************
这是在生成一篇学习JAVADOC的测试API
**********************************
*/
public class test1{

/**
TEST1的成员变量
*/
static int t1=1;

/**
@param t1 打印的参数
*/
void print1(int t1){
System.out.printlf("t1");
}

/**
主方法，程序入口
@param args 主方法 固定参数
*/
public static void main(String args[]){
System.out.println("test"+t1);

}
}

//test2.java
package TEST2;
/**
***********************************
这是在生成一篇学习JAVADOC的测试API2
***********************************
@author LANCE
@version test2.0
*/
public class test2{

/**
TEST1的成员变量
*/
static int t2=2;


/**
方法PRINT1
@param t2 打印的参数
*/
public void print1(int t2){
System.out.printlf("t2");
}

/**
主方法，程序入口
@param args 主方法 固定参数
*/
public static void main(String args[]){
System.out.println("test"+t2);
print1(t2);
}
}