IEDA中JavaDoc的自动生成、手动生成，以及生成html文档

1 自动生成类的注释

JavaDoc就是java特有的一种注释。

1.1 配置

首先，IDEA点击File-->Settings

然后Editor-->File and Code Templates-->Class

之后在这地方，添加一些代码

/**
* ${description}
*
* 

* 创建日期：${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* 
* @author  你的名字
* @since   创建该类时候的软件版本号
* @version 当前软件版本号
*/

直接把上面的代码，全部拷贝过去。
添加完之后，这个部分的全部代码应该是这样的：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")


/**
* ${description}
*
* 

* 创建日期：${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* 
* @author  你的名字
* @since   创建该类时候的软件版本号
* @version 当前软件版本号
*/

public class ${NAME} {
}

最后点击OK

1.2 使用

刚才我们做了什么呢?其实就是为了给java类自动添加必要的JavaDoc注释

我们现在创建一个类试试，在任意包上右键单击，创建一个Java Class


输入类名，然后回车。

之后弹出窗口

这个是干啥的？让你输入这个类的描述信息的，也就是说明你创建这个类，是干啥的。

我们输入一下（可以用中文）

之后OK

我们就创建好一个类了

这个时候，我们需要修改一下3个箭头指向的地方，简要说明

• @author 说明这个类的作者是谁
• @version 说明最后修改完这个类的时候，这个软件现在的版本号是多少【所以这个需要后期不断改】
• @since 说明第一次创建这个类的时候，版本号是多少

备注：还记得我们刚才要求插入一段代码，其实就是这个，如果你熟悉这几个属性的话，可以删掉汉字的注释，毕竟也挺麻烦的还得先删除再写上。

2 手动生成方法的注释

刚才，类有注释了，那类方法也得有注释对吧！

我们先写个类

之后为它写注释，注意下面的操作

首先输入/**

然后按回车

两个方法都是如此

之后变成了这样

解释一下

• 红色方框：写该方法的功能描述（中英文皆可）
• 绿色方框：写参数的含义
• 橘色方框：写返回值的含义

例如

注意，很多时候其实写清楚功能就行，参数容易看懂，没说明特别要求的话就删掉即可

3 生成html文档

你应该将jdk 11 的API文档，我们也要生成类似的文档。

首先，Tools-->Generate JavaDoc

点击之后的界面

• 箭头指向的是生成html的路径，自己设置即可
• 方框的内容，要求和我的设定完全一样，其他不用改

zh_CN
-encoding utf-8 -charset utf-8

之后点OK即可，会生成这些




你会发现我们刚才的各种设置，都是没有白费的

4 补充：JavaDoc

JavaDoc的知识，有兴趣可以学习

参考链接2

另外还有一个方法，就是直接查看java自带类的文件

鼠标停留在String上，按住Ctrl键，之后单击鼠标。

之后你就能查看String类的内容了，你会发现官方自带类的Java Doc设定，和我们刚才的要求是一样的。