• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

how to javadoc enum?

 
Jason Hocker
Ranch Hand
Posts: 132
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I have two enums, and I can't find the answer in the javadoc docuementation on how to properly document and format this in the code to meet the standards.

How best to indent an enum, and how to javadoc it?
 
R van Vliet
Ranch Hand
Posts: 144
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Jay,

I suppose it depends a bit on how much you need to comment on individual enum values rather than the enum as a whole (which you should javadoc as you do classes or interfaces). If you wish to comment each value I usually end up with something like this :

 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic