我尝试在我的 javadocs 上添加这种类型的标题部分，但我未能以一种简单而有用的方式做到这一点。我能做到的唯一方法是使用 HTML，我认为 HTML 不应该在代码中占有一席之地。
这是我制作的 javadoc 示例。我希望我的 javadoc 看起来与机器人完全一样，所以我希望添加标有红色方块的标题部分，而不需要进入 HTML。
问问题
2169 次
3 回答
7
如果您希望生成的文档包含指向类的链接，例如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 …}除了和之外，没有使用 HTML 的文本格式选项{@literal …}。如果您想要更多选项，则必须为特定选项编写Taglets。这是实现源代码和 HTML 代码分离的最简单方法。因此，您可以定义语义 @tags 并通过Taglet实现特定格式。
或者你编写一个完整的Doclet来完全控制输出，但我认为你不想要这个。
但是您应该首先（再次）阅读JavaDoc 文档，因为您可能错过了一些选项，这些选项可能无法给出您所要求的确切结果，但允许改进您的文档，从而改变您的优先级。（在开始编码还不可能的事情之前，了解所有可能的事情可能会有所帮助。）
于 2013-11-11T11:45:51.187 回答
4
以这种方式设计它怎么样：
<i><b>public void doSomething({@link String}).</b></i>
看起来正是您想要的样子。
于 2013-11-10T18:58:24.237 回答
2
你可能想看看这篇文章。我认为这与您想要做的类似。Javadoc 链接到另一个包
于 2013-11-13T05:33:34.070 回答