[prev] [index] [next]

Comments (cont)

Guidelines for comments from Kernighan/Pike:
  • Don't belabour the obvious
  • Comment functions and global data
  • Don't comment bad code, rewrite it
  • Don't contradict the code
  • Comments should clarify, not confuse