有人能给我展示一下那个javadoc标签的例子吗?
我不太明白如何在代码中使用它。
javadoc文档中有一些很好的例子。它总是指向文档的根目录,因此如果您想在每个页面上包含某些内容,可以使用它来找到javadoc的根目录,因为相对路径会因页面而异。
例如,要在生成的每个文档页面顶部包含公司标志,您可以将logo.png
放在文档的根目录中,然后添加:
<img src="{@docRoot}/logo.png">
到Javadoc标题
以下是几个标签
@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
文档标准:http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#tag
docRoot
的。 - Jean-François Savard
@docRoot
类比于HTML中的<base>
标签。 - Popsjavadoc -header '<img src="{@docRoot}/logo.png">'
。 - Michael Mrozek