注释

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

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

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

Javadoc API 文档非常有名。 Java JDK 类附带了 Javadoc API 文档。 大多数流行的 IDE 工具会自动读取 Javadoc 标签，并在使用该类、属性或方法的任何地方，将标签内容自动显示在鼠标光标悬停在文本上的时候。

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

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

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

在大量使用 XML 描述符的地方，现在可以使用另一种方法，那就是 Java 注释。 从 EJB 3.0 开始，可以使用 Java 注释来定义 EJB，而无需使用 XML。 此外，新的 JPA (Java 持久 API) 也使用注释。

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

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