Java学习(对象与类)——文档注释，生成JavaDoc文件

最新推荐文章于 2023-02-20 11:16:42 发布

Iron_Sp-man

最新推荐文章于 2023-02-20 11:16:42 发布

阅读量320

点赞数

分类专栏： Java基础学习文章标签： java

本文链接：https://blog.csdn.net/qq_48664605/article/details/120771737

版权

44 篇文章 1 订阅

订阅专栏

注释的插入

javadoc实用工具从下面几项中抽取信息
- 模块
- 包
- 公共类和接口
- 公共的和受保护的字段
- 公共的和受保护的构造器及方法
每个文档注释/**.......*/包含标记，以及之后紧跟着的自由格式文本
- 标记以@开头，例如@since，@param
- 自由格式文本的第一句话应该是一个概要性的句子
- javadoc将自动将这些概要句子抽取出来生成概要页
在自由格式文本中，可以使用HTML修饰符例如，用于强调的<em>......</em>等

一般只需要把公共字段(静态常量建立字段)

/**
*Generally refers to the PI in mathematics
*/
public static final double PI = 3.14159265358979323846;

@since
- 建立一个始于条目，text文本可以是引入这个特性的这个版本的任何描述
@author name
- 这个标记将产生一个作者条目
@version text
- 这个标记将产生一个版本条目，对当前版本进行描述
@see和@link
- 只提供类，方法，变量的名字，Javdoc就会在文档中插入一个超链接
- 注意：一定要用#号键分隔类名与方法名
- 如果在see标记后面有一个<,就需要指定一个超链接

想要产生包注释，就需要在每一个包目录中添加一个单独的文件，这里有以下两种选择
1. 提供一个名为package-info.java的Java文件。这个文件必须包含一个初始的以/**和*/界定的javadoc注释，后面是一个package语句。不能再包含更多的代码
2. 提供一个名为package.html的HTML文件，会抽取标记<body></body>之间的所有文本

使用IDEA生成javadoc文件

IDEA生成JavaDoc详细学习链接：

IDEA生成javadoc文档时无法访问FileSystem报错链接：

参考书籍：Java核心技术卷1(原书第11版)

关注