Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This seems to somehow be a topic of debate between developers. Everything I’ve written here is my idea of an ideal guideline, which I try to stick to but often fail. I think collectively we’d benefit from following some guidelines on code comments, if anything for our own future benefit, as well as others on the team.

Useful articles:

Code Tells You How, Comments Tell You Why

Comment Only What the Code Cannot Say | by Kevlin Henney | Medium

...