Як створити Javadoc для окремих переліків класу


84

Я пишу javadoc для класу, який містить власні переліки. Чи є спосіб створити javadoc для окремих переліків? Наприклад, зараз у мене є щось подібне:

/**
 * This documents "HairColor"
 */
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };

Однак це лише документує всі переліки в цілому:

Створений Javadoc

Чи є спосіб задокументувати кожне зі значень HairColor окремо? Не переносячи перерахування у власний клас або не змінюючи його з переліку?

Заздалегідь дякую за будь-яку допомогу.


З цікавості, чому ти хочеш? Ви перерахували перелік як privateвкладене перерахування, тому користувачі вашого класу в будь-якому випадку не можуть використовувати перелік чи його значення. І якщо це має бути загальнодоступним та автономним, ніж у чому велика справа в документування його як власного підрозділу?
Mark Peters

2
У моєму фактичному коді це загальнодоступно. І ви знаєте, якими можуть бути стандарти компанії. "Це було б краще" "Шкода, ми, хто нічого не знаємо про програмування, вважаємо, що ви повинні робити це таким чином". Lol
Snowy Coder Girl

Справедливо. Просто не забудьте повідомити їм, що випуск буде відсунутий на тиждень через незмінні вимоги до документації, яку, мабуть, ніколи не прочитати. Це, як правило, навішує вуха тому, хто взагалі піклується про свій бізнес.
Марк Пітерс

1
Ха-ха. Javadoc досить невикористаний як javadoc. Але я люблю це за кодування. Деякі програмісти мають імена методів, які не мають нічого спільного з тим, що насправді відбувається. Подібно getCat повертає всіх котів, які підбігли на дерево за останні 10 днів, не враховуючи вівторків чи свят. Ха-ха
Snowy Coder Girl

@RachelG. Це ціле явище, що кожен розробник вважає, що він / він перевершує інших розробників. Хоча без образ.
OddDev

Відповіді:


99

Ви робите це так само, як і будь-яку іншу змінну, яку ви б зробили javadoc.


/**
 *  Colors that can be used
 */
public enum Color
{
    /**
     * Red color
     */
    red,

    /**
     * Blue color
     */
    blue

}

РЕДАГУВАТИ:

Від Paŭlo Ebermann: Перелік - це окремий клас. Ви не можете включити повну документацію до класу, що вкладає (принаймні, без виправлення стандартного документа).


2
Це породжує те саме (зверніть увагу на посилання на знімку). Я прагну помістити їх безпосередньо в клас javadoc (а не посилатись на інший javadoc). Але спасибі =) +1 за вдосконалення опису проблеми.
Snowy Coder Girl

4
@ Рейчел: Перерахування - це окремий клас. Ви не можете включити повну документацію до класу, що вкладає (принаймні, без виправлення стандартного документа).
Paŭlo Ebermann

Ага. Я переживав якось так, як це було, коли виникало посилання. Я думаю, єдиним способом включити окремі перелічення було б змінити його на внутрішній клас, а потім оголосити там об’єкти та javadoc їх.
Snowy Coder Girl

@ user489041: Чи можете ви включити важливі коментарі (наприклад, мій) у відповідь для подальшого використання?
Paŭlo Ebermann

Якщо ви хочете посилатися на нього, ви завжди можете використовувати {@link Color}або навіть, {@link Color#red}наприклад, або навіть просто {@link #red}перебуваючи в одному документі з будь-якого іншого javadoc, включаючи клас javadoc.
flungo

69

Ви можете створити посилання на кожен елемент переліку. Усі елементи будуть перераховані в javadocs до класу enum.

/**
 *  Colors that can be used
 *  {@link #RED}
 *  {@link #BLUE}
 */
public enum Color {

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.