当前位置:首页 > 文章列表 > 文章 > java教程 > Java文档注释支持部分HTML标签,用于格式化和美化生成的API文档。以下是常见的支持标签:1.基本文本格式标签<b>:加粗文本<i>:斜体文本<u>:下划线文本<tt>:等宽字体(通常用于代码)<font>:设置字体颜色、大小等(不推荐使用,因兼容性问题)2.段落与列表<p>:段落<ul>和<li>

Java文档注释支持部分HTML标签,用于格式化和美化生成的API文档。以下是常见的支持标签:1.基本文本格式标签<b>:加粗文本<i>:斜体文本<u>:下划线文本<tt>:等宽字体(通常用于代码)<font>:设置字体颜色、大小等(不推荐使用,因兼容性问题)2.段落与列表<p>:段落<ul>和<li>

2026-03-16 14:35:34 0浏览 收藏
Java文档注释(Javadoc)虽允许嵌入HTML以增强可读性,但其标签支持并非全集可用——JDK 8及以上版本稳定支持、、、、等语义化基础标签,而、、等已废弃或受限,style属性、JavaScript、iframe及自定义标签则被主动过滤;实际使用中需兼顾兼容性、可访问性与安全性,优先采用语义清晰的标签结构,避免表现型写法和复杂嵌套,并通过-html5参数确保输出符合现代标准,让API文档既专业可靠又长期可维护。

Java 文档注释中 HTML 标签支持情况

Java 文档注释(即以 /** ... */ 包裹的 Javadoc)在解析时会将其中的 HTML 标签当作原始 HTML 处理,但支持程度取决于生成工具(主要是 javadoc 工具)的版本和输出目标(如 HTML5、HTML4),并非所有标签都安全可用,部分标签会被过滤或忽略。

基础 HTML 标签基本可用

以下标签在大多数 JDK 版本(JDK 8 及以上)中可直接使用,且能正确渲染为 HTML:


  • :段落与换行(
    推荐自闭合写法

      1. :列表结构
      2. :内联代码与预格式化文本( 更常用,语义更准)
      3. :强调加粗与斜体(比 / 更推荐,语义清晰)
      4. :表格(简单表格可用,但响应式支持弱)

        需谨慎使用的标签

        以下标签虽不报错,但存在兼容性或可访问性问题:

        • :已废弃,JDK 12+ 默认禁用,建议用 CSS 替代(但 Javadoc 不支持自定义 CSS,故应避免)
        • :支持,但路径必须是相对路径(相对于生成文档的根目录),且需确保资源随文档一并发布;推荐仅用于必要图示,避免绝对路径或网络 URL
        • :支持内部锚点(如 #method-name)和外部链接,但跨模块跳转需配合模块系统配置

        明确不支持或被剥离的内容

        为安全与标准化考虑,Javadoc 工具会主动移除以下内容:

        • 所有 JavaScript(如