20、Java文档注释

目录

一、文档注释标记

二、Javadoc 命令

三.IDEA中导出JAVA文档

---

        Java文档注释是一种特殊的注释形式，它以/**开始，以*/结束，通常出现在类、方法、字段等的声明前面，用于生成代码文档。这种注释可以被工具提取并生成API文档(JDK手册就是这样形成的)，如JavaDoc。文档注释允许你在程序中嵌入关于程序的信息，你可以使用javadoc工具软件来生成信息，并输出到HTML文件中。文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。在生成API文档时会提取以public、protected修饰的内容。文档注释必须写在类、接口、方法、构造器、成员字段前面，而写在其他位置，比如函数内部，是无效的文档注释。下面是详细描述：

一、文档注释标记

标记	位置	说明
@author	类、接口	指定程序的作者
@version	类、接口