自分のプロジェクトで Java の列挙型を使い始めたばかりで (仕事で JDK 1.4 を使用する必要があります)、列挙型に JavaDoc を使用するベスト プラクティスについて混乱しています。
この方法は機能することがわかりましたが、結果のコードは少し洗練されていません。
/**
* Doc for enum
*/
public enum Something {
/**
* First thing
*/
FIRST_THING,
/**
* Second thing
*/
SECOND_THING;
//could continue with more
}
列挙型宣言をコンマで連鎖せずに独自の行で分割する方法はありますか、またはこれが列挙型に JavaDoc を使用するための最良の方法ですか?
質問の最初の部分に答えるには、各列挙値をコンマで区切る必要があります。私の知る限り、それを回避する方法はありません。
個人的には、あなたが提示した方法でコードに問題はありません。私にとって列挙型を文書化するための完全に合理的な方法のようです。
Mikeが述べたように、列挙型の値はコンマで区切る必要があり、列挙型宣言に最初にリストされるものでなければなりません（インスタンス変数、定数、コンストラクター、メソッドが続く場合があります）。
列挙型を文書化する最良の方法は通常のクラスに似ていると思います。列挙型は列挙型全体の機能と役割の説明を取得し（ " Something values are used to indicate which mode of operation a client wishes..."）、各列挙型の値はその目的と機能のJavadoc説明を取得します（ " FIRST_THING indicates that the operation should evaluate the first argument first.."）。
列挙値の説明が短い場合は、として1行に配置すること/** Evaluate first argument first. */をお勧めしますが、各列挙値を独自の行に保持することをお勧めします。ほとんどのIDEは、この方法で自動的にフォーマットするように構成できます。
グーグルコード検索オンラインツールがあります-http ：//www.google.com/codesearch
「lang：javapublicenum」のようなことをして検索しようとしています