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
Revision: r1.1 - 16 Jun 2008 - 02:24 - Main.guest