文档注释 /** */ 与 javadoc
xmhky 原创图解 · 更新于 2026-09
唯一能被工具提取、自动生成 API 文档的注释类型。
什么是文档注释
- 以
/**开始，以*/结束 - 通常出现在类、方法、字段等的声明前面
- 可以被 javadoc 工具提取，生成 HTML 格式的 API 文档
书写格式两条规矩
- ① 主要描述：
/**之后的第一行或几行是关于类/变量/方法的主要描述 - ② @ 标签：之后跟一个或多个
@标签，每个 @ 标签必须在新行开始，或紧跟星号* - 多个相同类型的标签要放成一组（例如三个 @see 挨着写）
javadoc 工具用法
- 基本命令：
javadoc SquareNum.java - 输出：HTML 文件（每个类一个独立 HTML）+ 继承树形结构 + 索引
- 常用选项：
-d outputDir指定输出目录，-encoding UTF-8指定编码