aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes javadoc enum Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of Spring in Action this week in the Spring forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "javadoc enum" Watch "javadoc enum" New topic

javadoc enum

Olu Shiyan
Ranch Hand

Joined: Jun 10, 2010
Posts: 57

Hi folks,

I want use an enum to store the database constants constants e.g number of bytes used to store the magic cookie etc. However, Im not sure about how to javakdoc and enum? Did anyone use enums recently? If so, please explained how you applied javadoc to the enum
i.e. did you specify each enum constant on a separate line and did you insert a javadoc comment for each enum constant?


Roel De Nijs

Joined: Jul 19, 2004
Posts: 5407

I did it like this:

SCJA, SCJP (1.4 | 5.0 | 6.0), SCJD
Olu Shiyan
Ranch Hand

Joined: Jun 10, 2010
Posts: 57

Allan Cheong
Ranch Hand

Joined: Nov 12, 2009
Posts: 71

I have javadoc for the enum class, constructor and toString method.

It is sorta covered in the JavaRanch Style Guide.
subject: javadoc enum