javadoc 自定义标签

Question

我已经在谷歌上搜索了将近一个小时，但找不到任何有关制作自定义标签的好信息。当我检查 javadoc 的帮助时，这是关于自定义标签的...

-tag <名称>:<位置>:<标题>

它没有定义任何事物是什么。我认为 name 将是标签的名称，而 header 可能是标签在生成 javadoc 时所说的内容，但位置是什么以及它是如何使用的？

名称、位置和标题是否也需要用引号或类似的东西括起来？

一些自定义标签的例子，也许对什么位置的解释对我来说是一个巨大的帮助。关于制作 javadoc 的这个特定部分，我找不到任何好的教程......

Answer 1

看起来你只调用了 javadoc -help .这只是对选项的简短提醒，而不是完整的文档。

原则上，所有内容都在 javadoc 文档页面上进行了详细解释(对于 Windows 和 Linux/Solaris )。

-tag option用于向标准 doclet 添加自定义标签，而无需创建自己的 taglet(您将使用 -taglet option )甚至自己的 doclet。

该选项的所有参数都必须是一个命令行参数，因此根据您的 shell，如果它们包含任何空格，您通常必须将它们(一起或单独)放在引号中。

-tag tagname:Xaoptcmf:"taghead"

标记名是您的自定义标记的名称 - 例如，如果您正在编写 @todo在源代码中，名称将是 todo .

中间参数是允许此标签的位置的标识符。这可以是 a 的组合(无处不在)，o (仅在概览页面中)，p (关于包文档)，t (用于类或接口(interface)文档)，c (对于构造函数)，m (用于方法)，f (对于字段)。此外，还可以有 X表示标签被接受但没有显示输出。 (那么你不需要标签头部分)。

taghead 应该在生成的源代码中显示为标签的标题，例如 To Do:对于我们的待办事项标签。

所以，如果你 @todo应允许在任何地方使用标签并打印 To Do: ，你会使用

-tag todo:a:"To Do:"