Variables
Some kinds of variables benefit from documentation and some do not. The following sections give tips on how to craft any documentation appropriate for some kinds of variables:
- Documenting Variables Based on Scope
- Documenting Specific Kinds of Data
- Documenting Constants [DI27] [WHAT]
- Make Meanings of Booleans Clear [DI28] [WHAT]
- Document the Meanings of “Unpopulated” Values [DI29] [WHAT]
- Document Values with Special Meanings [DI30] [WHAT] [WHY] [HOW]
- Document Ranges of Numeric Values [DI31] [WHAT] [WHY] [HOW]
- Document Units of Numeric Data [DI32] [WHAT]
- Document Data Formats That Cannot Be Concisely Captured in Names [DI33] [WHAT] [HOW]
- Document Specifics of Filesystem Paths [DI34] [WHAT]
- Document Time Zones for Dates/Times [DI35] [WHAT]
- Document Bit-Level Details For Packed Data [DI36] [WHAT] [HOW]
