我尝试在我的 javadoc 上添加这种类型的标题部分,但我未能以简单而有用的方式做到这一点。我能做到这一点的唯一方法是使用 HTML,而且我认为 HTML 不应该在代码中占有一席之地。
这是我制作的 javadoc 的示例。我希望我的 javadoc 看起来与 android 完全一样,所以我希望添加标有红色方块的标题部分,而不进入 HTML。
如果您希望生成的文档包含指向类的链接,例如java.lang.String
你必须告诉javadoc链接到哪里。例如。在命令行上你可以说
-link http://docs.oracle.com/javase/7/docs/api/
这不会自动完成,因为您必须决定链接哪个版本或是否要链接本地镜像。可以有多个-link
在命令行上链接多个库文档。
标准 doclet 不支持每个方法的附加标头。但您可以在文档文本下方添加自定义标签。例如,您可以定义自己的标签,例如@API.level.1
并将其添加到文本下方的文档注释中(在一行中)并运行javadoc
with
-tag "API.level.1:a:Added in <a href='http://mycompany/Version1'>API Level 1</a>"
创建与您的示例类似的行(尽管它将位于文本下方)。
除了不使用 HTML 之外,没有任何文本格式选项{@code …}
and {@literal …}
。如果你想要更多选项,你必须写Taglets http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html对于特定的选项。这是实现您想要的源代码和 HTML 代码之间的分离的最简单方法。因此,您可以定义语义 @tags 并通过以下方式实现特定格式Taglet.
或者你写一个完整的Doclet完全控制输出,但我认为你不想要这个。
但您应该首先阅读JavaDoc文档 http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html(再次)因为您可能错过了一些选项,这些选项可能无法给出您所要求的确切结果,但可以改进您的文档,从而改变您的优先级。 (在开始编码尚不可能的事情之前了解一切可能的事情可能会有所帮助。)
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)