logstatements vs comments - benclifford/text GitHub Wiki

Messages in log statements and exceptions are visible both when reading the code and when running the code.

Messages in comments are visible only when reading the code.

Often it is useful for the information to be available at both times.

There is no need to feel shame that this is not documenting things, just because it isn't a source-code level comment.