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

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

-тег ‹ имя >:‹ местоположения >:‹ заголовок >

Он не определяет, что есть какие-либо вещи. Я думаю, что имя будет именем тега, а заголовок, вероятно, будет тем, что говорит тег при создании javadoc, но что такое местоположения и как оно используется?

Также должны ли имя, местоположения и заголовок быть в кавычках или что-то в этом роде?

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


javadoc
person Chuck    schedule 01.03.2011    source источник

Ответы (3)


arrow_upward
9
arrow_downward

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

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

Параметр -tag предназначен для добавления пользовательских тегов в стандартный доклет. без создания собственного теглета (там вы должны использовать параметр -taglet< /a>) или даже собственный доклет.

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

-tag имя тега:Xaoptcmf:"заголовок тега"

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

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

-tag todo:a:"To Do:"
person Paŭlo Ebermann    schedule 03.03.2011

arrow_upward
2
arrow_downward

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

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

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

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

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

person beardedlinuxgeek    schedule 09.01.2013

arrow_upward
1
arrow_downward

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

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

person Michael Berry    schedule 14.03.2011