枚举的文档注释中的@author和@version标记

Question

我是否必须将@author和@version标记放在枚举的文档注释中？ How to Write Doc Comments for the Javadoc Tool说

  

* @author（仅限类和接口，需要）

     

* @version（仅限类和接口，需要。见脚注1）

和我的IDE的枚举文档注释模板包括@author。

Answer 1

你投入Javadoc，无论你的组织授权应该放在Javadoc中。在一天结束时，它是一个沟通工具，您可以决定要使用哪些部分以及不使用哪部分。

Answer 2

枚举类型是一种类（注释类型是一种接口）。

因此当它只说类和接口时，它实际上只意味着类型，并且包含枚举类型（但不包括方法，字段，构造函数和包）。