Javadoc =>如何添加一个很酷的标题标签

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

在此处输入图像描述

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

在此处输入图像描述

如果您希望生成的文档包含指向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 API Level 1" 

创建一个类似于你的例子的行(虽然它将在文本下面)。


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

或者你编写一个完整的Doclet来完全控制输出,但我不认为你想要这个。


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

这样的风格怎么样:

public void doSomething({@link String}).

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

你可能想看一下这篇文章。 我认为它与您想要做的类似。 Javadoc链接到另一个包