Commenting Data Declarations
- Comment the units of numeric data
- Comment the range of allowable numeric values
- Use enumerations instead of magic numbers or magic strings
- Comment limitations on input data
- Document flags to the bit level
- Stamp comments related to a variable with the variable's name
- Document global data, briefly justify the need for global data
--
ShawnDB - 16 Jun 2008
to top
Copyright © 1999-2024 by the contributing authors.
All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback