注释

主题: 前言 入门 语言基础 类和对象 聚合 异常 并发编程 Javadoc & 注释 设计用户界面 高级主题

导航 Javadoc & 注释 主题： Javadoc 注释介绍 创建自定义注释 元注释 帮助编译器

Javadoc 是 Java 源代码文档生成器，从 1.0 版开始就随 Java 语言一起引入。 编写良好的 Java 代码应该包含 Javadoc 标签。 这些标签位于 /** ... */ 注释块中，因此编译器会忽略它们。 一个单独的实用程序将读取代码并创建 Java API html 文件。

Javadoc API 文档是众所周知的。 Java JDK 类附带 Javadoc API 文档。 大多数流行的 IDE 工具会自动读取 Javadoc 标签，并在使用该类、属性或方法的地方，当鼠标光标悬停在文本上时，会自动显示标签内容。

随着 Java 的成熟，“Javadoc 概念”被认为是用于其他目的的出色工具，例如使用 XDoclet 开源程序生成 XML 描述符，甚至生成 Java 代码。

借助 XDoclet 程序，可以在代码中使用额外的 Javadoc 标签，该程序可以理解这些标签并生成代码或数据。 例如，引入了 Javadoc 标签来为 EJB 生成 XML 描述符。 它在 EJB 的构建过程中引入了一个额外的步骤，并且在编译代码时，XDoclet 将生成 XML 描述符。

认识到它的有用性，在 Java 5 中，注释 被添加到 Java 语言中。 注释标签不在注释块内。 注释是类的一部分，可以在运行时访问。

在 XML 描述符被大量使用的地方，现在可以使用 Java 注释作为一种替代方法。 从 EJB 3.0 开始，可以定义 EJB，而无需使用 XML。 此外，新的 JPA (Java 持久 API) 使用注释。

重要的是要注意，Javadoc 和注释是两种不同的构造。

• Javadoc 标签位于注释块内，因此被编译器忽略。
• 注释标签位于注释块之外，并且由编译器进行类型检查。