Java基础语法12：JavaDoc生成文档

JDK帮助文档

JDK 帮助文档（Java Development Kit Documentation）是 Oracle 官方提供的关于 Java 开发工具包（JDK）的详细技术文档，也称为Java API 文档。它包含了 Java 标准库中所有类、接口、方法、字段的详细说明，是 Java 开发者不可或缺的参考工具。

点击跳转到Oracle官方文档

JavaDoc

Javadoc 是 Java 提供的一种工具，用于从源代码中提取注释并生成 HTML 格式的 API 文档。通过遵循特定的注释规范，你可以为类、方法、字段等添加描述信息，这些信息会被 Javadoc 工具解析并生成专业的文档，就像官方 JDK 文档一样。

参数信息

@author 作者名
@version 版本号
@since 指名需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

注释规范

JavaDoc注释以/**开头，以*/结尾，必须放在类、方法或字段声明之前。注释中可以使用特殊标签(如@param、@return)来描述参数、返回值等信息。

package com.xiaochaole.base;//类注释
/*** @author xiaochaole* @version 1.0* @since 1.8*/public class Doc{String name;//方法注释/**** @param name* @return* @throws Exception*/public String test(String name) throws Exception {return name;}
}