Documenting Enums [DI11] [WHAT] [WHY] [HOW]
Tip DI11
Enumerated types or “enums” provide a way to define a data type restricted to a specific “enumerated” list of values. Enums are typically relatively simple and may not need as much documentation as other custom data types. However, some overview documentation or documentation on specific values can be helpful.
Consider making sure the following are clearly documented:
What the enum represents
The purpose of the enum
How it is intended to be used/maintained
Any special considerations for enum values
Unless you have long enum value lists that are self-documenting, we recommend documenting each enum value to ensure the meaning is clear to readers.
Examples: