idea 关于 java 类和方法的注释生成，关于 javadoc的注解
一、idea关于java类上的文档注释生成
类注释文档是随着java文件创建而创建的。
截图来自以下csdn
https://blog.csdn.net/qq_34581118/article/details/78409782
二、 idea关于java方法上的文档注释生成
（1） 使用 / + a + tab 三个组合键。
（2） 可以在方法外面使用上面的组合键有效。
截图来自以下csdn https://blog.csdn.net/qq_34581118/article/details/78409782
三、 javadoc的相关注解
写在类上面的JavaDoc
写在类上的文档标注一般分为三段：
- 第一段内容：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束。
- 第二段内容：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都是以英文句号作为结束。
- 第三段内容：文档注解，用于标注作者，创建时间，jdk版本支持等。
写在方法上面的JavaDoc
- 第一段内容：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束。
- 第二段内容：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都是以英文句号作为结束。
- 第三段内容：文档标注，用于标注参数，返回值，异常，参阅等。
方法详细描述上经常使用html标签，通常都以p标签开始，而且p标签通常都是单标签，不使用结束标签，其中使用最多的就是p标签和pre标签,ul标签, i标签。
pre标签可定义预格式化的文本。被包围在pre标签中的文本通常会保留空格和换行符。而文本也会呈现为等宽字体，pre标签的一个常见应用就是用来表示计算机的源代码。
一般p经常结合pre使用，或者pre结合@code共同使用(推荐@code方式)
扫描二维码关注公众号，回复：
9464166 查看本文章
四、 idea生成javadoc文档
- 点击tools，然后generate javadoc
- 配置参数
local: zh_CN
line arguments: -encoding UTF-8 -charset UTF-8 -windowtitle 测试使用javaDoc
五、java文档注解说明
参考链接：https://blog.csdn.net/lsy0903/article/details/89893934
- p结合pre使用， 用在详细描述中的代码使用举例
- pre结合@code使用，用在详细描述中的代码使用举例
- @param注解
- @param 函数参数名 参数描述
- @return注解
- @return 返回值描述
- @throws注解
- @throws 异常类型 异常类型描述，用于描述方法内部可能抛出的异常。
- @exception注解
- @exception 用于描述方法签名throws对应的异常
- @deprecated注解
- @deprecated 用于描述一个类或者成员方法已经过期，经常配合{@link}使用
- @see注解
- @see既可以用于类也可以用于方法，表示可以参考的类或者方法
- @value注解
- {@value}用于标注在常量上用于表示常量的值
