пользовательские теги javadoc

Question

Я гуглю почти час и не могу найти никакой полезной информации о создании пользовательских тегов.Когда я проверяю справку для javadoc, это говорит о пользовательских тегах ...

-tag : :

Это не определяет что-либо из вещей,Я думаю, что name будет именем тега, а заголовок - это, вероятно, то, что тег говорит, когда вы генерируете Javadoc, но что такое местоположения и как он используется?быть в кавычках или что-то в этом роде?

Несколько примеров пользовательских тегов и, возможно, объяснение того, что это за места, будет ОГРОМНОЙ помощью для меня.Я не могу найти хорошие учебники по этой конкретной части создания Javadoc ...

Answer 1

Похоже, вы только что вызвали javadoc -help.Это лишь краткое напоминание об опциях, а не полная документация.

В принципе все подробно объясняется на странице документации javadoc (для Windows и Linux / Solaris).

Опция -tag предназначена для добавления пользовательских тегов в стандартный доклет без необходимости создания собственного тега (там вы должны использовать -tagletoption ) или даже собственный доклет.

Все параметры опции должны быть одним аргументом командной строки, поэтому в зависимости от вашей оболочки вы обычно должны помещать их (вместе или по отдельности) в кавычки, еслиони содержат любые пробелы.

-tag tagname :Xaoptcmf: " taghead "

• The tagname - это имя вашего пользовательского тега - например, если вы пишете @todo в источнике, имя будет todo.
• Средний параметр является идентификатором дляместа, где этот тег разрешен.Это может быть комбинация a (везде), o (только на странице обзора), p (в документации пакета), t (для документации класса или интерфейса), c (для конструкторов)), m (для методов), f (для полей).Кроме того, может быть X, означающее, что тег принят, но вывод не показан.(Тогда вам не нужна часть taghead ).
• Тег - это то, что должно быть показано в сгенерированном источнике в качестве заголовка для вашего тега, напримерTo Do: для нашего todo-тега.

Итак, если вам нужно разрешить тег @todo везде и вывести To Do:, вы должны использовать

-tag todo:a:"To Do:"

Answer 2

Пауло Эберманн прав, но я хотел бы добавить, что Оракул сказал:

Предотвращение конфликтов - Если вы хотите вырезать собственное пространство имен, вы может использовать разделенное точками соглашение об именах, аналогичное используемому для пакеты: com.mycompany.todo. Солнце продолжит создавать стандарт теги, имена которых не содержат точек. Любой тэг, который вы создаете, переопределит поведение тега с тем же именем, определенным Sun. Другими словами, если вы создаете тег или тег @todo, он всегда будет одинаковым поведение, которое вы определяете, даже если позднее Sun создаст стандартный тег то же имя

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

Это означает, что вы не должны использовать @todo, вы должны использовать @to.do

Подробнее здесь .

Answer 3

Вы можете написать собственные Taglets и относительно легко подключить их к Javadoc - здесь есть документ, объясняющий, как здесь .Обратите внимание, что вам нужно указать полный абсолютный путь к местоположению тега, но это можно сделать относительно легко в ant.

Теглеты занимают больше времени, чем команда tag, но они предлагают гораздо большую гибкостьпоскольку вы по сути выполняете любой выбранный вами Java-код - таким образом вы можете обрабатывать или отображать любую информацию по своему усмотрению.