如何创建自定义javadoc标签?
如何创建自定义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
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
}
请注意,自定义标签的格式为@[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脚本,这样您就不必每次都浏览一次该对话框),您将自定义标记以粗体显示,并显示下面的值。
PS我还没有找到一种方法来为自定义标签添加自动完成功能,但在Indigo中似乎不可能,也许它将在未来的版本中发布(不知道Juno是否有此功能)。
如果你想要多个,就像javadoc -tag pre -tag post -tag invariant
,它要求命令行参数。 不要使用html的东西