1 自动生成类的注释

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

1.1 配置

首先，IDEA点击File-->Settings

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

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

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

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

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")/**
* ${description}
*
* <p>
* 创建日期：${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设定，和我们刚才的要求是一样的。

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

javadoc文档的生成方法_Cocoa 代码注释与文档生成
Cocoa 代码注释与文档生成本文的文档规范部分的内容参考自:NSHipster 的 Swift Documentation 作者 & Nate Cook 本文知识目录背景曾经以为好的代 ...
在Vs.net中集成 NDoc生成的 Html Help 2帮助文档
注:NDoc是一个Open Source的For .Net 文档自动生成软件.它可以通过 .Net中XML的注释标签来生成非常漂亮的MSDN风格的类库文档.(相对于VS.Net自己带的Comment ...
Java使用POI生成折线图导出到word文档（折线图）
本篇文章主要介绍,如何使用Apache POI组件生成折线图导出到word文档中,具体步骤看下文. 一.实现效果 Java使用POI技术生成折线图导出到word文档中,最终生成的折线图如下所示: 二. ...
亿愿Word文档批量多语言翻译---word文档翻译专家！几十种语言随意快速互译！可以生成中外文，中英文对照内容文档！
亿愿Word文档批量多语言翻译-软件功能简介 [亿愿Word文档批量多语言翻译]采用目前最强大的.国际著名公司的谷歌翻译引擎,自动识别语言种类,把英文.日文.韩文.德文.法文.俄文等几十种外国语言的文 ...
java生成word文档图片_java生成带有图片的word的文档-Go语言中文社区
生成带有图片的word的文档 @RequestMapping(params ="getWordByDate",produces = "text/html;charset= ...
Sandcastle方法生成c#.net帮助类帮助文档chm
Sandcastle方法生成c#.net帮助类帮助文档chm Sandcastle方法生成c#.net帮助类帮助文档即chm后缀的文档,其实是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第 ...
java根据pdf模板生成pdf_Java 复制、压缩PDF文档
在日常办公中,掌握操作PDF文档的能力尤为重要.在前文中我使用Java程序来演示过如何合并和拆分PDF文档.本文将介绍如何复制和压缩文档.通常复制文档有两种形式,一种是跨文档复制,即将一个文档复制到另 ...
oracle11gr2 active data guard,Oracle11gR2 Aactive DataGuard(手动)装配部署及维护文档（三）之升级及rman...
Oracle11gR2 Aactive DataGuard(手动)安装部署及维护文档(三)之升级及rman l 第六部分: dataguard其它管理问题一．滚动升级DG 升级概要 ...
转：在 C# 中使用 P/Invoke 调用 Mupdf 函数库显示 PDF 文档
在 C# 中使用 P/Invoke 调用 Mupdf 函数库显示 PDF 文档一直以来,我都想为 PDF 补丁丁添加一个 PDF 渲染引擎.可是,目前并没有可以在 .NET 框架上运行的免费 PDF ...

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