Documentation - Comments

• How to comment:

  • data declarations
    • units of numeric data
    • document range of allowed values
    • comment on encoded meanings
    • comment on input data limitations
    • document flags to the bit level
    • document all global data
• control structures
  • give reasons for decisions
  • summarize the outcome of decisions
  • comment end of blocks in nested controls