javadoc命令生成Java文件的帮助文档

1、首先使用在Java文件中写上文档注释,可以在文档注释中加一些东西,你觉得要加的,比如版本号,亦或者是作者之类的,或者是某一个方法的说明,如果不写文档注释也是可以生成帮助文档的,文档注释如下,举个例子

/**
 * @author Me
 * @function Area
 */

2、打开命令行(也就是cmd窗口)找到java文件的目录,如下

javadoc命令生成Java文件的帮助文档

3、然后输入javadoc -d doc +java文件名既可以了,然后就会像上图一样,生成一个doc文件夹,在你的java文件所在的目录下,这里的命令行中javadoc和后面的-d有一个空格记得打

4、打开文件夹doc,找到里面的index.html文件就可以了,这个就是帮助文档

javadoc命令生成Java文件的帮助文档

javadoc命令生成Java文件的帮助文档

目前还不清楚帮助文档有啥作用,仅做记录,后面会补充的,寻思着就是用来记录吧!Maybe