Documentation - Comments

• How to comment:

  • routines
    • keep comments close to the code they describe
    • describe wach routine in a few sentences at the top
    • document and differentiate between input and output data
    • keep a change history
    • comment on numerical precision
    • give a reference to the source of the algorithm
• files, modules, programs
  • first line: content and purpose of the file
  • give name for all authors
  • state copyright