JavaDoc

JavaDoc

javadoc命令是用来生成自己API文档的

 

参数信息

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况

 

生成JavaDoc文档

通过命令行生成javadoc文档

1. 从文件夹中打开

    

 

2. 在当前文件夹中打开命令行并输入javadoc 参数 Java文件

    

3. 双击index.html打开

    

4. 打开看到文档

    

使用IDEA生成JavaDoc文档

1. 在导航栏中选择Tools>>Generate JavaDoc点击

    

    

2. 配置参数

    

Output directory:输出文件夹路径以及Other command line arguments:命令行参数