javadoc

JAVADOC

javadoc风格的好处

• 标准化文档：JavaDoc 是 Java 官方工具（javadoc）支持的格式，能将注释提取并转换为 HTML 文档。
• 明确接口规范：通过 @param、@return 等标签，清晰说明方法的参数、返回值和功能，便于其他开发者调用。
• IDE 支持：现代 IDE（如 IntelliJ、Eclipse）会解析 JavaDoc，在代码提示中显示这些注释，提升开发效率。

javadoc格式

/**
 * 方法的总体描述（这里是空的，实际应补充功能说明）。
 *
 * @param b int整型二维数组 参数b的说明（未具体描述用途）
 * @param a int整型二维数组 参数a的说明（未具体描述用途）
 * @return int整型一维数组 返回值的说明（未具体描述含义）
 */

还有以下注释参数

注释	解释
@author常用	标识类或接口的作者
@param常用	描述方法参数的含义
@version常用	指定版本号或版本信息
@since	标记从哪个版本开始引入该功能。
@deprecated	标记方法或类已过时，并说明替代方案
@see	引用其他相关类、方法或文档
@return常用	描述返回值的作用
@throws / @exception	说明方法可能抛出的异常及其原因

使用idea生成javadoc文档

生成后的结果

javadoc指令生成文档

javadoc [options] [sourcefiles] [@files]

关键路径参数：

-d <directory>：指定文档生成的目标目录。
-sourcepath <path>：指定源代码的根目录（类似 javac 的 -sourcepath）。
直接指定源文件：可以省略 -sourcepath，直接列出 .java 文件或通配符。

场景 1：生成单个包的文档
假设项目结构如下：

myproject/
└── src/
    └── com/
        └── example/
            └── MyClass.java
命令：
javadoc -d docs -sourcepath src com.example.MyClass

或直接指定文件：

javadoc -d docs src/com/example/MyClass.java

场景 2：生成整个包的文档
javadoc -d docs -sourcepath src com.example.*

或进入 src 目录后执行：
cd src
javadoc -d ../docs com.example.*

场景 3：生成多模块项目的文档
如果项目有多个包（如 com.example.util 和 com.example.core）：
javadoc -d docs -sourcepath src com.example.util com.example.core

场景 4：使用通配符生成所有类的文档
javadoc -d docs -sourcepath src com.example.*

或递归生成（需结合 -subpackages）：
javadoc -d docs -sourcepath src -subpackages com.example