/
Document Values with Special Meanings [DI30]
Document Values with Special Meanings [DI30]
Tip DI30
Sometimes a variable may need to take some “special” values that would differ from the variable’s normal meaning. If possible, prefer using coding constructs to separate out such special cases in the code itself. But if a variable absolutely must take on values with special meanings, make sure to document that.
Examples:
, multiple selections available,
Related content
Document Ranges of Numeric Values [DI31]
Document Ranges of Numeric Values [DI31]
More like this
Document Data Formats That Cannot Be Concisely Captured in Names [DI33]
Document Data Formats That Cannot Be Concisely Captured in Names [DI33]
More like this
Document Why Values Are Chosen
Document Why Values Are Chosen
More like this
Documenting Member Variables/Fields/Properties [DI26]
Documenting Member Variables/Fields/Properties [DI26]
More like this
Document Usage Assumptions [DI16]
Document Usage Assumptions [DI16]
More like this
Documenting Global Variables [DI25]
Documenting Global Variables [DI25]
More like this