Javadoc =＆gt;如何添加一个很酷的标题标签

Question

我尝试在我的javadocs上添加这种类型的标题部分，但我没有以简单有用的方式完成它。我能做到的唯一方法是使用HTML，我认为HTML不应该在代码中占有一席之地。

这是我制作的javadoc的一个例子。我希望我的javadoc看起来与机器人完全一样，所以我希望添加标有红色方块的标题部分，而不是使用HTML。

Answer 1

如果您希望生成的文档包含指向java.lang.String等类的链接，则必须告诉javadoc链接的位置。例如。在命令行上你可以说

-link http://docs.oracle.com/javase/7/docs/api/

这不是自动完成的，因为您必须决定要链接的版本或是否要链接到本地​​镜像。命令行上可以有多个-link来链接多个库文档。

标准doclet不支持其他每个方法标头。但您可以在文档文本下添加自定义标记。例如，您可以定义自己的标记，例如@API.level.1，并将其添加到文本下方的文档注释中（在一行中），并使用

运行javadoc

-tag "API.level.1:a:Added in <a href='http://mycompany/Version1'>API Level 1</a>"

创建一个类似于您的示例的行（尽管它将在文本下方）。

---

除了{@code …}和{@literal …}之外，没有使用HTML的文字格式选项。如果您需要更多选项，则必须为特定选项编写Taglets。这是实现源代码和HTML代码之间分离的最简单方法。因此，您可以通过 Taglet 定义语义@tags并实现特定格式。

或者您编写完整的 Doclet 以完全控制输出，但我认为您不希望这样。

---

但是你应该首先阅读JavaDoc documentation（再次），因为可能有一些你错过的选项可能无法提供你所要求的确切结果但允许改进你的文档可能会改变你的优先级。 （在开始编写不可能的事情之前，了解可能的一切可能会有所帮助。）

Answer 2

如何以这种方式设计风格：

<i><b>public void doSomething({@link String}).</b></i>

完全按照你想要的方式看。

Answer 3

您可能想看一下这篇文章。我认为这与你想做的相似。 Javadoc Linking to Another Package