如何创建自定义javadoc标签？

Question

如何创建自定义javadoc标签，例如@pre / @post？我发现了一些解释它的链接，但我没有运气。这些是一些链接：

http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.html

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html

Answer 1

java代码

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

java doc选项

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

<强>输出

  

这是我的标签：

     

    嘿嘿......

  

Answer 2

不应该使用HTML创建自定义标记，因为javadoc可能会改变它的实现或它如何呈现数据，也许它们将来会开始使用Markdown，而且Javadoc导出器也不会捕获缺少的信息。有空的“标签”。

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

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

请注意，自定义标记的格式为@[prefix].[tagName]，这是因为doclet（或其他Eclipse插件）可能会使用相同的名称释放自己的标记，而您的标记只会覆盖标准标记，所以我们添加一个前缀，以减少发生这种情况的可能性。

来自doclet的评论。

  

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

---

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

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

您应该注意到“Extra Javadoc options ..”文本框具有您必须添加的值 用于Javadoc导出器创建标记的HTML等效项。

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

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

现在，当您导出Javadoc时（我还建议您保存ANT脚本，这样您就不必每次都通过此对话框），您的自定义标记将以粗体显示描述和值下方。

P.S。我还没有找到一种方法来添加为自定义标签添加自动完成的功能，但在Indigo中似乎不可能，也许它将在未来版本中发布（不确定Juno是否有）。

Answer 3

如果您想要多个，请执行{{1}}之类的操作请求命令行参数。不要使用HTML内容

Answer 4

我做的不是最好的解决方案，但可读：

  /** <p><b>Pre:</b></p>  <Ul>True</Ul>
    * <p><b>Post:</b></p> <Ul>The x is pushed onto the top of the stack,
    *                       and the rest of the stack remains unchanged.</Ul>
    *
    * @param x              Indicates the current node
    */
   public void push(int x){
      ...
   }

直到找到正确的答案，希望它有所帮助！