Documenting Generic/Templated Types [DI13] [WHAT]
Tip DI13
Many programming languages support “generic” or “template” features, allowing you to define a custom type that can serves as a “template” for working “generically” with a family of different types. Such generic or templated types typically have “parameters” for the type itself, which can be important to document.
Like function parameters, these generic/template parameters form part of the interface to the type, so ensure you document what these are and how they are intended to be used (many documentation generator styles have explicit tags for these):
