自分自身の列挙型を含むクラスのjavadocを書いています。個々のenumsのjavadocを生成する方法はありますか？クラスの個々の列挙型をJavadocする方法
/**
* This documents "HairColor"
*/
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };
しかし、この文書だけ全体として列挙型のすべて：
は、ヘアカラーのそれぞれを文書化する方法はあり例えば、今私はこのような何かを持っています値は個別に？列挙型をそれ自身のクラスに移動したり、列挙型から変更したりすることなく、
ご協力いただきありがとうございます。
あなたはjavadocと同じような変数を使用します。
/**
* Colors that can be used
*/
public enum Color
{
/**
* Red color
*/
red,
/**
* Blue color
*/
blue
}
EDIT：パウロEbermannから
：列挙型が別のクラスです。包括クラス（少なくとも、標準ドックレットにパッチを当てることなく）に完全なドキュメントを含めることはできません。
これは同じことを生成します（スナップショットのリンクに注意してください）。私はクラスjavadoc（別のjavadocにリンクするのではなく）にそれらを直接配置しようとしています。しかし、問題の説明を進めるために感謝=）+1。 –
@Rachel：列挙型は別のクラスです。包括クラス（少なくとも、標準ドックレットにパッチを当てることなく）に完全なドキュメントを含めることはできません。 –
うん。私は心配していました。それはリンクが発生したときの様子でした。個々の列挙型を含める唯一の方法は、それを内部クラスに変更し、そこにオブジェクトを宣言してそれらをjavadocすることだと思います。 –
各列挙型アイテムへのリンクを作成できます。すべての項目は、enumクラスのjavadocにリストされます。
/**
* Colors that can be used
* <li>{@link #RED}</li>
* <li>{@link #BLUE}</li>
*/
public enum Color {
/**
* Red color
*/
RED,
/**
* Blue color
*/
BLUE
}
奇妙なことから、なぜあなたはしたいですか？列挙型は 'private'ネストされた列挙型としてリストされているので、クラスのユーザーは列挙型またはその値をとにかく使用できません。そしてそれがそれ自身の単位としてそれを文書化することの大したことよりも公然と独立していることを意図しているのであれば？ –
私の実際のコードでは、公開されています。そして、あなたは会社の基準がどのようにできるかを知っています。 「これは良いだろう」「あまりにも悪く、プログラミングについて何も知らない人は、あなたがそうするべきだと思う」 Lol –
十分に良い。おそらく決して読むことのできないドキュメンテーションのための不動の要求のために、リリースが1週間後にプッシュバックされることを彼らに伝えるようにしてください。それは、通常、ビジネスを気にしている誰かの耳を掻き立てるものです。 –