下面的标记可以用在类文档的注释中。

    @author name

    这个标记将产生一个“author”(作者)条目。可以使用多个@author标记,每个@author标记对应一名作者。

    @version text

    这个标记将产生一个“version”(版本)条目。这里的text可以是对当前版本的任何描述。

    下面的标记可以用于所有的文档注释。

    @since text

    这个标记将产生一个“since”(始于)条目。这里的text可以是对引入特性的版本描述。例如,@since version 1.7.1

    @deprecated text

    这个标记将对类、方法或变量添加一个不再使用的注释。text中给出了取代的建议。例如,

@deprecated Use <code>setVisible(true)</code> instead

    通过@see和@link标记,可以使用超级链接,链接到javadoc文档的相关部分或外部文档。

    @see reference

    这个标记将在“see also”部分增加一个超级链接。它可以用于类中,也可以用于方法中。

    这里的reference可以选择下列情形之一:

        package.class#feature label

        <a href="...">label</a>

        "text"

    第一种情况是最常见的。只要提供类、方法或变量的名字,javadoc就在文档中插入一个超链接。例如,

        @see com.horstmann.corejava.Employee#raiseSalary(double)

    建立一个链接到com.horstmann.corejava.Employee类的raiseSalary(double)方法的超链接。可以省略包名,甚至把包名和类名都省去,此时,链接将定位于当前包或当前类。

    需要注意,一定要使用井号(#),而不要使用句号(.)分割类名与方法名,或类名与变量名。Java编译器本身可以熟练地断定句点在分隔包、子包、类、内部类与方法和变量时的不同哦呢含义。但是javadoc实用程序就没有这么聪明了,因此必须对它提供帮助。

    如果@see标记后面有一个<字符,就需要指定一个超链接。可以超链接到任何URL。例如:

        @see <a href="www.horstmann.com/core">The Core Java home page</a>

    在上述各种情况下,都可以指定一个可选的标签(label)作为锚链接(link author)。如果省略了label,用户看到的锚的名称就是目标代码名或URL。

    如果@see标记后面有一个双引号(")字符,文本就会显示在“see also”部分。例如,

        @see “Core Java2 volume 2”

    可以为一个特性添加多个@see标记,但必须将它们放在一起。

    如果愿意的话,还可以注释中的任何位置放置指向其他类或方法的超级链接,以及插入一个专用的标记,例如,

        {@link package.class#feature label}

    这里的特性描述规则与@see标记规则一样。