Documentation - Comments

• Kinds of Comments:

  • code summary
    • distills a few lines of code into one or two sentences
    • mainly useful for programmers other than the author
• description of the code's intent
  • explains the purpose of a file, module, section of code
  • understanding the original programmers intent is the most difficult part in maintaining code