Good Data Type Overview Documentation
A good data type overview makes it clear to other programmers:
What the type is
How to properly use it
How to properly maintain it
This applies regardless of the “kind” of data type (interface, class, struct, union, enum, type alias, etc.). Simpler types (typedefs, enums) typically need less documentation than more complex types like classes, though always keep your particular situation in mind.
The sections below give guidance on crafting effective data type documentation in all these areas. The sections build off of each other, so you can see how some documentation evolves from the “minimum” for a data type to encompass additional important information.
