使用Intellij IDEA生成JavaDoc
以下是常用的注释标签,规范书写生成的文档中才能显示:
@author 作者 @version 版本 @see 参考转向 @param 参数说明 @return 返回值说明 @exception 异常说明
找到顶部工具栏中的Tools==》Generate JavaDoc…
单击弹出设置窗口,更改一些设置
前四个单选按钮,控制我们想要把哪些文件输出,分别是整个工程、未提交的文件、当前文件、自定义范围
下面的复选框分别是包含测试代码、包含jdk和第三方jar包、链接到jdk
Output directory表示输出目录
下面三个框中从左向右分别是输出的级别、输出的文件中的内容(包括层级树,索引等等,默认的就可以)、输出注释中的信息(这里一定要规范书写注释,要不不会正常输出)
下面三个文本框只需要对第二个进行添加参数即可,否则会提示编码问题
-encoding UTF-8 -charset UTF-8