Javadoc 生成文档时的编码与中文支持

夏芳小哥_6726

夏芳小哥_6726

2026-03-21

263人浏览

原创

Java项目用Javadoc生成含中文注释的API文档时,需统一源文件、Javadoc读取及HTML输出编码为UTF-8:确保源码存为UTF-8,IDE配置对应编码,命令行加-encoding和-docencoding参数,Maven/Gradle插件中同步设置三者。

javadoc 生成文档时的编码与中文支持

Java 项目用 Javadoc 生成 API 文档时,如果源码含中文注释,默认可能显示乱码或报错,核心原因是编码不一致——源文件是 UTF-8,但 Javadoc 工具默认按平台编码(如 Windows 的 GBK)读取,导致解析失败。

确保源文件本身是 UTF-8 编码

这是前提。IDE(如 IntelliJ 或 Eclipse)需将 Java 文件保存为 UTF-8 格式:

  • IntelliJ:File → Settings → Editor → File Encodings → Global Encoding / Project Encoding → 设为 UTF-8,同时勾选 “Transparent native-to-ascii conversion”(避免 \uXXXX 转义)
  • Eclipse:右键项目 → Properties → Resource → Text file encoding → 选择 UTF-8
  • 用记事本或 VS Code 打开 .java 文件时,确认右下角显示 “UTF-8”,而非 ANSI/GBK

命令行执行 Javadoc 时显式指定编码

直接调用 javadoc 命令必须加 -encoding 和 -docencoding 参数:

  • -encoding UTF-8:告诉 Javadoc 按 UTF-8 解析源文件内容
  • -docencoding UTF-8:指定生成的 HTML 文件内部声明的字符编码(影响浏览器正确渲染)
  • 完整示例:
    javadoc -encoding UTF-8 -docencoding UTF-8 -charset UTF-8 -d docs src/com/example/*.java

注意:-charset 非必需,但加上可确保 HTML 的 正确写入,增强兼容性。

Maven 项目中配置 maven-javadoc-plugin

在 pom.xml 中配置插件时,需设置 和 :

<plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-javadoc-plugin</artifactid><version>3.6.0</version><configuration><encoding>UTF-8</encoding><docencoding>UTF-8</docencoding><charset>UTF-8</charset></configuration></plugin>

运行 mvn javadoc:javadoc 即可正确处理中文。

Gradle 项目中的等效配置

在 build.gradle 中为 javadoc 任务添加选项:

javadoc {
    options.encoding = 'UTF-8'
    options.docEncoding = 'UTF-8'
    options.charSet = 'UTF-8'
    // 若使用新版本 Gradle(如 8.0+),还需显式设置工具链
    if (JavaVersion.current().isJava17Compatible()) {
        options.addStringOption('source', '17')
    }
}

执行 ./gradlew javadoc 后,build/docs/javadoc/ 下的 HTML 就能正常显示中文。

不复杂但容易忽略:三个编码参数各司其职,缺一不可;只要源码、读取、输出三者统一为 UTF-8,中文注释就能清晰呈现。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11497

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8602

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7392

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1224

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

988

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1476

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3009

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20271

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1315

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习