Do I have to put the @author
and @version
tags in the documentation comment of an enumeration?
How to Write Doc Comments for the Javadoc Tool says
* @author
(classes and interfaces only, required)
* @version
(classes and interfaces only, required. See footnote 1)
and my IDE's documentation comment template for enumerations includes @author
.
You put into Javadoc, whatever your organization mandates should be put in Javadoc. At the end of the day its a communication tool, you decide which parts of it you want to use and which you don't.