@authorと@version EnumerationのDocコメントのタグ

Question

@authorと@versionというタグを列挙のドキュメントコメントに入れなければなりませんか？ How to Write Doc Comments for the Javadoc Tool

* @author（クラスとインタフェースのみ、必要な）

* @version（必要なクラスとインターフェイスのみが、。脚注1を参照）

言うと列挙のための私のIDEのドキュメンテーションコメントのテンプレートが含まれて@author。

Answer 1

あなたは組織がJavadocに置く必要があるものは何でも、あなたはJavadocに入れます。一日の終わりにコミュニケーションツール、あなたはそれのどの部分を使いたいのか、あなたはそれを使わないのかを決める。

Answer 2

enum型は一種のクラスです（注釈型は一種のインタフェースです）。

したがって、それが実際にタイプのみを意味し、クラスとインタフェースのみを言い、そして列挙型を含む（しかし、メソッド、フィールド、コンストラクタおよびパッケージを除く）場合。