@author和@version枚舉文檔中的標記Comment

Question

是否必須將@author和@version標記放在枚舉的文檔註釋中？ How to Write Doc Comments for the Javadoc Tool說

* @author（類和只，所需的接口）

* @version（類和接口只，要求見注1）

和枚舉我的IDE的文檔註釋模板包括@author。

Answer 1

你把它放進Javadoc，無論你的組織授權應該放在Javadoc中。在一天結束時它是一個溝通工具，你決定你要使用哪一部分，哪一部分不使用。

Answer 2

枚舉類型是一種類（而註釋類型是一種界面）。

因此當它說類和接口僅，它實際上指類型僅，並且包括枚舉類型（但不包括方法，字段，構造和包）。