javadoc @docRoot

时间:2010-06-28 06:14:14

标签: java javadoc

有人能告诉我一个javadoc标签的例子吗?

我不太清楚如何在代码中使用它

2 个答案:

答案 0 :(得分:6)

javadoc documentation有几个很好的例子。它始终指向文档的根目录,因此如果您希望在每个页面上包含某些内容,则使用它来查找javadoc根目录,因为相对路径在页面之间会有所不同

例如,要在每个生成的文档页面的顶部包含您公司的徽标,您可以将logo.png放在文档的根目录中,然后添加:

<img src="{@docRoot}/logo.png">

到javadoc标题

答案 1 :(得分:-2)

这些是以下几个标签

@author  //this will give name of author

@see     //it is used to point to refrence

@since   //this will give from which version it is included

@link    // this is used to provide link to another file

示例:http://www.docjar.net/html/api/java/util/Collections.java.html

doc标准:http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#tag