JavaDoc学习笔记

JavaDoc学习笔记

java学习过程中的一些笔记

使用JavaDoc可以生成自己的Java项目的API文档。

在代码中输入“/** ”然后回车：

/**
 *
 */

然后可以在其中输入“@”加上参数信息，记录你的文件的相关参数信息，如作者、版本号等等：

/**
 * @author Jarvisis
 * @version 1.0
 * @since 1.8
 */

然后打开文件所在位置：

然后在此路径下打开cmd命令行，快捷方式是在路径前加上cmd空格然后回车：

（如果觉得字体等不合适代话，可以右键命令行窗口的边框，然后修改默认设置：

然后命令上执行javadoc：

javadoc -encoding UTF-8 -charset UTF-8 java0001.java

其中，-encoding和-charset两个参数是将编码和字符编码的格式都设置为utf-8，避免出现一些编码格式错误，最后的java0001.java是我的文件名。意思是把我们的java0001.java文件编译成一份java文档。

然后回车，会显示正在生成各种文件。

回到原目录下，可以看到生成了一堆文件。点开其中的index.html首页文件：

可以看到生成了和我们的java文件内容相对应的Java文档。我们这里文件里没写什么东西，所以看到都是空白。

以上即为javadoc的基本使用方法。

如果你是用IDEA写代码的话，也可以使用Tools里面的Generate JavaDoc来生成文档：

里面的各选项根据需求进行调整即可。