javadoc自定义标签

Question

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

-tag <name>:<locations>:<header>

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

名称,位置和标题也需要用引号或类似的东西吗？

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

Answer 1

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

原则上,javadoc文档页面(适用于Windows和Linux/Solaris)详细介绍了所有内容.

该-tag选项用于将自定义标记添加到标准doclet,而无需创建自己的标记(您可以使用该-taglet选项)或甚至自己的doclet.

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

-tag 标记名:Xaoptcmf: " taghead "

• 该标记名是你的自定义标签的名称-例如,如果你正在写@todo的来源,名称将是todo.
• middle参数是允许此标记的位置的标识符.这可以是a(无处不在),o(仅在概述页面中),p(在包文档上),t(对于类或接口文档),c(对于构造函数),m(对于方法),f(对于字段)的组合.此外,可能存在X接受标签但未显示输出的含义.(那你不需要标头部分).
• 该taghead是什么,应在生成的源作为标题为您的标记,例如显示To Do:我们的todo标签.

所以,如果你的@todo标签应该被允许到处打印To Do:,你会使用

-tag todo:a:"To Do:"