Please enable JavaScript.

Coggle requires JavaScript to display documents.

The Art of Readable Code Dustin Boswell Trevor Foucher (1. Surface…

- - - - Remove unused code
      - Be familiar with the libraries around
- - - - Don't comment on facts that can be derived quickly from the code itself. However, the tricky thing is to identify what is fact, and what is your understanding.
      - Don't comment to explain a bad name, fix the name instead
    - - Recording your thoughts, insights that reader may not know
      - Comment flows in your code. For some reasons, there maybe some issues with you code that you can't solve it at the moment. Don't be embarrassed to document those flaws.
      - Comment on constants, to explain why it has the assigned value (extremely helpful to understand numeric value)
      - Put yourself in the reader's shoes, anticipate likely questions, and comment those answers
      - Comment on what are the limitations of your code or the likely pitfalls when using your code, or any surprising behaviours
      - Try to give some big-picture, high-level or summary comment
      - Don't stop too long to think about a good comment, just start writing it directly. Read it again, find out is not clear that can be improved. Then make improvements.