javadoc自定义标签

Question

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

-tag＆lt; name＆gt;：＆lt;位置＆gt;：＆lt;标题＆gt;

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

名称，位置和标题是否也需要引号或类似内容？

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

Answer 1

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

原则上，javadoc文档页面（Windows和Linux/Solaris）详细解释了所有内容。

-tag option用于向标准doclet添加自定义标记，而无需创建自己的标记（您可以使用-taglet option）甚至是自己的doclet。

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

  

-tag 标记名 :Xaoptcmf:“标记头”

• 标记名是自定义标记的名称 - 例如，如果您在源代码中编写@todo，则名称为todo。
• middle参数是允许此标记的位置的标识符。这可以是a（无处不在），o（仅在概述页面中），p（在包文档上），t（用于类或接口文档）的组合），c（对于构造函数），m（对于方法），f（对于字段）。此外，可以有X表示标记已被接受但未显示输出。 （那么你不需要标头部分）。
• 标头应在生成的来源中显示为标记的标头，例如我们的todo-tag为To Do:。

因此，如果您应该在任何地方允许@todo标记并打印To Do:，那么您将使用

-tag todo:a:"To Do:"

Answer 2

PaŭloEbermann是正确的，但我想补充说甲骨文说：

  

避免冲突 - 如果您想切出自己的命名空间，那么   可以使用类似于用于的点分隔命名约定   包：com.mycompany.todo。 Sun将继续创造标准   名称不包含点的标签。您创建的任何标记都将覆盖   由Sun定义的相同名称的标记行为。换一种说法，   如果你创建一个标签或标签@todo，它将始终具有相同的   您定义的行为，即使Sun稍后创建了标准的标记   同名

http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#tag

这意味着您不应该使用@todo，您应该使用@to.do

更多信息here。

Answer 3

你可以编写自定义Taglet并将它们挂钩到Javadoc相对容易 - 有一个文档解释了here的方式。请注意，您需要指定taglet位置的完整绝对路径，但这可以在ant中相对容易地完成。

Taglet比使用tag命令更耗时，但它们提供了更大的灵活性，因为您实际上是在执行您选择的任何Java代码 - 这样您就可以根据需要处理或显示任何信息。