Home/ Questions/Q 53689
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-10T17:06:10+00:00

I’ve just started using Java’s enums in my own projects (I have to use

  • 0

I’ve just started using Java’s enums in my own projects (I have to use JDK 1.4 at work) and I am confused as to the best practice of using JavaDoc for an enum.

I have found that this method works, but the resultant code is a little unrefined:

/** * Doc for enum */ public enum Something { /** * First thing */ FIRST_THING, /** * Second thing */ SECOND_THING; //could continue with more }

Is there any way I could break up the enum declarations on their own lines without chaining them by commas, or is this the best approach for using JavaDoc for an enum?

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. To answer the first part of your question, you do have to separate each enum value with a comma. As far as I know, there’s no way around that.

    Personally I don’t have a problem with the code the way you’ve presented it. Seems like a perfectly reasonable way to document an enum to me.

    • 0