43、Java 文档注释与 Java Web Start 简介

Java 文档注释与 Java Web Start 简介

1. Java 文档注释

1.1 文档注释概述

Java 支持三种类型的注释，前两种是 // 和 /* */ ，第三种是文档注释，以 /** 开头，以 */ 结尾。文档注释允许将程序信息嵌入到程序本身，可使用 javadoc 工具（JDK 提供）提取信息并生成 HTML 文件，方便对程序进行文档化，Java API 库就是用这种方式进行文档编写的。从 JDK 9 开始， javadoc 支持模块。

1.2 javadoc 标签

javadoc 工具识别多种标签，分为独立标签（以 @ 开头，也叫块标签，需单独成行）和内联标签（以 {} 开头，可用于较大描述中），还可使用一些标准 HTML 标签，但部分标签如标题标签会破坏 javadoc 生成的 HTML 文件外观，不建议使用。以下是一些关键标签：
| 标签 | 作用 | 语法 | 使用范围 |
| ---- | ---- | ---- | ---- |
| @author | 记录程序元素的作者 | @author description | 需在执行 javadoc 时指定 -author 选项，描述通