This is part of the Semicolon&Sons Code Diary - consisting of lessons learned on the job. You're in the workflows category.
Last Updated: 2024-11-23
Comments are the parts of the code that others are most likely to read. Therefore it pays, for both communication and reputation-related purposes, to leave a good impression. One trick is to enable spell check and re-read each comment, aloud, after being made. In addition, if any changes are made during this re-read, it ought to be proof read, from the start, once again.