Как Javadoc класса Индивидуальные перечисления
Я пишу javadoc для класса, содержащего его собственные перечисления. Есть ли способ генерировать javadoc для отдельных перечислений? Например, прямо сейчас у меня есть что-то вроде этого:
/**
* This documents "HairColor"
*/
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };
Однако это только документирует все перечисления в целом:
![The generated Javadoc]()
Можно ли каким-либо образом документировать каждую из значений HairColor отдельно? Не перемещая enum в него собственный класс или изменяя его из перечисления?
Заранее благодарим за помощь.
Ответы
Ответ 1
Вы делаете это точно так же, как и любая другая переменная, которую вы будете javadoc.
/**
* Colors that can be used
*/
public enum Color
{
/**
* Red color
*/
red,
/**
* Blue color
*/
blue
}
EDIT:
От Paŭlo Ebermann: Перечисление - это отдельный класс. Вы не можете включить свою полную документацию в класс включения (по крайней мере, без исправления стандартного doclet).
Ответ 2
Вы можете создать ссылку на каждый элемент перечисления. Все элементы будут перечислены в javadocs для перечисления класса.
/**
* Colors that can be used
* <li>{@link #RED}</li>
* <li>{@link #BLUE}</li>
*/
public enum Color {
/**
* Red color
*/
RED,
/**
* Blue color
*/
BLUE
}