Comments

From ym2149.org
Jump to navigationJump to search
  • comments distract from the code and are too easily lost in conflict resolution, or moved in reformatting
    • the initiated do not need to re-read the comments
  • use self-documenting names in preference to comments, add a new function if necessary
    • this is of more use to the uninitiated
  • when working on a ticket, that can be the decision record and commit messages should already refer to it
  • the readme doesn't have to be behind a pull request wall, it can simply contain a link to the wiki to make documentation more inclusive
  • when working on legacy code, assume it's all there for a reason even if it's bad code