如何创建自定义 javadoc 标签？

java 代码

/**
 * @custom.mytag hey ho...
 */

java doc 选项

-tag custom.mytag:a:"This is my Tag:"

输出

这是我的标签：

嘿嘿...

自定义标签不应该使用HTML创建，因为javadoc可能会改变它的实现或它呈现数据的方式，也许他们将来会开始使用Markdown，Javadoc导出器也不会捕获丢失的信息，你可能有空的“标签”。

首先使用您想要的任何标签：

/**
 * Comments and a {@link #methodLink} for this method.
 * 
 * @tt.wrapper {@link OtherClass}
 *
 */
public String extractName() {
    // method contents
}

请注意，自定义标签的格式为 ，这是因为 doclet（或其他 Eclipse 插件）可能会发布具有相同名称的自己的标签，而您的标签只会覆盖标准标签，因此我们添加了前缀以降低发生这种情况的可能性。@[prefix].[tagName]

来自 doclet 的评论。

可能覆盖未来标准标记的自定义标记：@wrapper 为避免潜在的覆盖，请在自定义标记名称中至少使用一个句点字符 （.）。

现在，您必须告诉 Javadoc 导出程序有关此自定义标记的信息。转到 Eclipse（在我的情况下是 Indigo）。@tt.wrapperProject > Generate Javadoc..

配置此对话框前两个屏幕的设置后（使用“下一步”更改屏幕），您应该看到此屏幕：

您应该注意到，“Extra Javadoc 选项..”文本框具有您必须为 Javadoc 导出程序添加的值，以便创建与标记等效的 HTML。

在我们的例子中，选项是这样的（如果你想要多个标签，把它们放在一个新行上）：

-tag tt.wrapper:a:"API Wrapper:"

现在，当您导出Javadoc时（我还建议您保存一个ANT脚本，这样您就不必每次都浏览此对话框），您将以粗体显示自定义标签，并带有描述和下面的值。

附言：我还没有找到一种方法来添加为自定义标签添加自动完成功能的功能，但在Indigo中似乎是不可能的，也许它会在未来的版本中出现（不确定Juno是否拥有它）。