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

Ответ 1

Java-код

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

вариант java doc

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

Выход

Это мой тег:

эй хо...

Ответ 2

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

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

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

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

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

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

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

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

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

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

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

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

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

Ответ 3

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

  /** <p><b>Pre:</b></p>  <Ul>True</Ul>
    * <p><b>Post:</b></p> <Ul>The x is pushed onto the top of the stack,
    *                       and the rest of the stack remains unchanged.</Ul>
    *
    * @param x              Indicates the current node
    */
   public void push(int x){
      ...
   }

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

Ответ 4

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