javadoc @docRoot答案

【问题标题】：javadoc @docRootjavadoc @docRoot
【发布时间】：2011-03-09 00:11:39
【问题描述】：

谁能给我看一个javadoc标签的例子吗？

我不太明白如何在代码中使用它

【问题讨论】：

【解决方案1】：

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

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

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

到 javadoc 标头

【讨论】：

源代码中没有用到吗？ javadoc 标头是什么意思？
@xdevel，以 Michael 的示例为基础，您可以认为 @docRoot 在概念上类似于 HTML 的 <base> 标签。
@xdevel2000 Javadoc 工具支持通过将-header 标志传递给每个页面的页眉来添加一些内容，因此您可以这样做javadoc -header '<img src="{@docRoot}/logo.png">'
@Michael > 在 Windows XP/7/2008/2003 下，我无法使用 -header 运行命令行，因为
@Zorg：确保引用正确。如果它仍然不起作用，请打开一个新问题，显示完整的命令行。

【解决方案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

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

【讨论】：

这根本不回答问题，问题是关于docRoot。