Я пишу javadoc для класса, который содержит собственные перечисления. Есть ли способ создать javadoc для отдельных перечислений? Например, сейчас у меня что-то вроде этого:
/**
* This documents "HairColor"
*/
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };
Однако это только документирует все перечисления в целом:
Есть ли способ задокументировать каждое значение HairColor индивидуально? Не перемещая перечисление в собственный класс или не меняя его из перечисления?
Заранее благодарю за любую помощь.
private
вложенное перечисление, поэтому пользователи вашего класса в любом случае не могут использовать перечисление или его значения. И если он задуман как общедоступный и автономный, то зачем документировать его как отдельную единицу?Ответы:
Вы делаете это так же, как и любую другую переменную, которую вы бы сделали javadoc.
/** * Colors that can be used */ public enum Color { /** * Red color */ red, /** * Blue color */ blue }
РЕДАКТИРОВАТЬ:
От Пало Эберманна: перечисление - это отдельный класс. Вы не можете включить его полную документацию во включающий класс (по крайней мере, без исправления стандартного доклета).
источник
{@link Color}
или даже{@link Color#red}
например, или даже{@link #red}
когда в том же документе из любого другого javadoc, включая класс javadoc.Вы можете создать ссылку на каждый элемент перечисления. Все элементы будут перечислены в javadocs для enum class.
/** * Colors that can be used * {@link #RED} * {@link #BLUE} */ public enum Color { /** * Red color */ RED, /** * Blue color */ BLUE }
источник