Как создать пользовательские tags javadoc?

Как создать пользовательские tags javadoc, такие как @pre / @post? Я нашел несколько ссылок, которые объясняют это, но мне не повезло с ними. Вот некоторые из ссылок:

http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.html

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html

код Java

/** * @custom.mytag hey ho... */ 

опция java doc

 -tag custom.mytag:a:"This is my Tag:" 

вывод

Это мой тег:

Хей-хо…

Пользовательские tags не должны создаваться с использованием HTML, потому что javadoc может изменить его реализацию или то, как он представляет данные, возможно, они начнут использовать Markdown в будущем, также экспортер Javadoc не уловит недостающую информацию, и у вас могут быть пустые «tags».

Сначала используйте любой тег, который вы хотите:

 /** * Comments and a {@link #methodLink} for this method. * * @tt.wrapper {@link OtherClass} * */ public String extractName() { // method contents } 

Обратите внимание, что пользовательский тег имеет формат @[prefix].[tagName] , это связано с тем, что doclet (или другой плагин Eclipse) может выпустить собственный тег с тем же именем, и ваш тег будет просто переопределять стандартный тег , поэтому мы добавляем префикс, чтобы сделать его менее вероятным.

Комментарий от doclet.

Пользовательские tags, которые могут переопределять будущие стандартные tags: @wrapper Чтобы избежать возможных переопределений, используйте по умолчанию как минимум один символ периода (.) В именах настраиваемых тегов.


Теперь вы должны сообщить экспортеру Javadoc об этом специальном теге, @tt.wrapper . Перейдите в Project > Generate Javadoc.. в Eclipse (Indigo в моем случае).

После настройки параметров для первых двух экранов этого диалога (с помощью «Далее» для изменения экранов) вы должны увидеть этот экран:

Третий экран конфигурации для Eclipse Doclet Javadoc Export

Вы должны заметить, что текстовое поле «Extra Javadoc options ..» имеет значение, которое вы должны добавить для экспортера Javadoc, чтобы создать эквивалент HTML вашего тега.

В нашем случае это вариант (если вы хотите несколько тегов, поместите их в новую строку):

 -tag tt.wrapper:a:"API Wrapper:" 

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

PS Мне еще предстоит найти способ добавить возможность добавления автозаполнения для пользовательских тегов, но в Indigo это кажется невозможным, возможно, это будет в будущих выпусках (не уверен, что у Juno есть).

Если вы хотите несколько, сделайте что-то вроде javadoc -tag pre -tag post -tag invariant где он запрашивает аргументы командной строки. Не используйте html-файл

Ну, что я сделал, это не лучшее решение, но оно читаемо:

  /** 

Pre:

    True
*

Post:

    The x is pushed onto the top of the stack, * and the rest of the stack remains unchanged.
* * @param x Indicates the current node */ public void push(int x){ ... }

Пока не будет найден правильный ответ, надейтесь, что это поможет!

  • Как увидеть JavaDoc в IntelliJ IDEA?
  • Eclipse: присоединить источник / javadoc к библиотеке через локальное свойство
  • Maven не работает на Java 8, когда tags Javadoc являются неполными
  • Давайте будем гением компьютера.