javadoc命令一键生成网页版api文档的核心是写对注释、选对源文件、执行正确命令;需用/* /注释、指定-sourcepath和编码参数,并输出到-d目录生成html文档集。

用 javadoc 命令一键生成网页版 API 文档,核心是三件事:写对注释、选对源文件、执行正确命令。只要 Java 环境已配置好(java -version 和 javadoc -help 能正常运行),整个过程不依赖 IDE,纯命令行即可完成。
确保源码含标准 Javadoc 注释
只有以 /** 开头、*/ 结尾的注释才会被识别。必须加在类、方法、字段声明之前,不能放在内部或后面。
- 类级注释建议包含
@author和@version,例如:/** @author 张三 @version 1.2 */ public class Calculator { ... } - 方法注释必须写清
@param(每个参数一行)、@return(如有返回值)、@throws(如有异常) - 中文注释需显式指定编码,否则容易乱码,后续命令中要加
-encoding UTF-8 -charset UTF-8
定位源码路径并执行基础命令
不需要进到每个 .java 文件所在目录,只需明确源码根路径(即包路径的起点)。比如源码结构是:src/com/example/Utils.java,且 Utils 属于 com.example 包,则 src 就是源码根目录。
- 生成单个文件文档:
javadoc -d doc -encoding UTF-8 -charset UTF-8 Utils.java - 生成整个包及其子包:
javadoc -d doc -sourcepath src -subpackages com.example -encoding UTF-8 -charset UTF-8 - 生成多个指定文件(支持通配符):
javadoc -d doc -encoding UTF-8 -charset UTF-8 src/com/example/*.java
添加常用可读性选项提升实用性
默认生成的页面较简陋,加几个参数就能让文档更专业、更易用:
-
-doctitle "我的工具库 API":设置浏览器标题栏和首页大标题 -
-windowtitle "工具库文档":单独控制浏览器标签页显示名 -
-header "<b>v2.1</b>":在每页右上角加版本标识(支持简单 HTML) -
-use:为每个类生成“使用该类的包”链接页,增强导航性 -
-link https://docs.oracle.com/javase/8/docs/api/:自动链接到 JDK 官方类(如String、List)
查看与验证生成结果
执行成功后,指定的输出目录(如 doc)下会生成完整 HTML 文件集。关键入口是:
- 打开
doc/index.html—— 总览页,含所有包、类、索引 - 点击某个类名,进入其详细页,参数、返回值、异常都会按结构清晰展示
- 检查中文是否正常显示;若乱码,说明漏了
-encoding或-charset - 确认
@see、{@link ClassName#method()}等链接能否跳转
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











