Function comments.

When writing a function comment, how should the error conditions be documented?

  Consistent with the idea that a function's comments should indicate what the
  function does and how to use it, the error conditions should indicate what
  the function considers an error, and what the function does when it
  encounters an error.
Received on Sun Feb 11 2007 - 21:28:45 EST