DEV Community

Discussion on: How do you take notes while you code?

Collapse
 
hollyw00d profile image
Matt Jennings

As someone who has rewritten way too many comments in the past, I:

  1. Add the bulk of my comments in the projects README.md file which should be at the root of a git repo.

  2. Add two or one lines of comments in code files, excluding the README.md file. A great example I've used for brief comments are the official React repo:
    github.com/facebook/react

Here's an example file with brief comments:
github.com/facebook/react/blob/mai...