idea java文档的注解说明与自动生成

最新推荐文章于 2024-05-22 10:20:52 发布

望月寄明

最新推荐文章于 2024-05-22 10:20:52 发布

阅读量2.9k

点赞数 4

分类专栏： javaWeb

本文链接：https://blog.csdn.net/qq_36723759/article/details/104068341

版权

24 篇文章 1 订阅

订阅专栏

一、idea关于java类上的文档注释生成

类注释文档是随着java文件创建而创建的。

截图来自以下csdn
https://blog.csdn.net/qq_34581118/article/details/78409782
在这里插入图片描述

（1）使用 / + a + tab 三个组合键。
（2）可以在方法外面使用上面的组合键有效。

截图来自以下csdn https://blog.csdn.net/qq_34581118/article/details/78409782

在这里插入图片描述

写在类上的文档标注一般分为三段：

在这里插入图片描述

第一段内容：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束。
第二段内容：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都是以英文句号作为结束。
第三段内容：文档标注，用于标注参数，返回值，异常，参阅等。
方法详细描述上经常使用html标签，通常都以p标签开始，而且p标签通常都是单标签，不使用结束标签，其中使用最多的就是p标签和pre标签,ul标签, i标签。

pre标签可定义预格式化的文本。被包围在pre标签中的文本通常会保留空格和换行符。而文本也会呈现为等宽字体，pre标签的一个常见应用就是用来表示计算机的源代码。

一般p经常结合pre使用，或者pre结合@code共同使用(推荐@code方式)
在这里插入图片描述

点击tools，然后generate javadoc
配置参数
local: zh_CN
line arguments: -encoding UTF-8 -charset UTF-8 -windowtitle 测试使用javaDoc

参考链接：https://blog.csdn.net/lsy0903/article/details/89893934

关注

专栏目录