javadoc @docRoot

Question

有人能给我展示一下那个javadoc标签的例子吗？

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

- xdevel2000

Answer 1

javadoc文档中有一些很好的例子。它总是指向文档的根目录，因此如果您想在每个页面上包含某些内容，可以使用它来找到javadoc的根目录，因为相对路径会因页面而异。

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

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

到Javadoc标题

- Michael Mrozek

---

那么它没有被用于源代码中吗？你所说的javadoc头是什么意思？ - xdevel2000

@xdevel，继续借鉴Michael的例子，你可以将@docRoot类比于HTML中的<base>标签。 - Pops

@xdevel2000 Javadoc工具支持通过传递“-header”标志向每个页面的头部添加内容，因此您可以执行javadoc -header '<img src="{@docRoot}/logo.png">'。 - Michael Mrozek

@Michael > 在 Windows XP/7/2008/2003 下，我无法使用 -header 运行您的命令行，因为 < 标签被解释为重定向。有什么想法吗？ - user825166

@Zorg：确保引用正确。如果仍然无法正常工作，请打开一个新问题，展示您完整的命令行。 - Paŭlo Ebermann

Answer 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

- deepak kumar

---

这完全没有回答问题，问题是关于docRoot的。 - Jean-François Savard