Skip to content

Commit

Permalink
Merge pull request #1293 from paroche/patch-9
Browse files Browse the repository at this point in the history
Update article.md
  • Loading branch information
iliakan authored Aug 30, 2019
2 parents 69c7961 + 8aca352 commit 4ed5a0d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion 1-js/03-code-quality/03-comments/article.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,6 @@ Good comments allow us to maintain the code well, come back to it after a delay
**Avoid comments:**

- That tell "how code works" and "what it does".
- Put them only if it's impossible to make the code so simple and self-descriptive that it doesn't require those.
- Put them in only if it's impossible to make the code so simple and self-descriptive that it doesn't require them.

Comments are also used for auto-documenting tools like JSDoc3: they read them and generate HTML-docs (or docs in another format).

0 comments on commit 4ed5a0d

Please sign in to comment.