Documenting Lightweight Type "Aliases" [DI10] [WHAT] [WHY]

Tip DI10

Many programming languages support creating custom “names” for existing types - essentially, a lightweight way to define your own types without the overhead of something like a class. We’ll refer to all of these lightweight “renamed” types as type “aliases” in this section.

Due to their lightweight nature, type aliases don’t typically need as much documentation as a full-fledged class. Still, brief documentation can be useful to explain why the type alias exists or how it’s intended to be used.