jeena/en.javascript.info
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge pull request #1293 from paroche/patch-9

Browse source 
Update article.md
This commit is contained in:
Ilya Kantor 2019-08-30 23:05:26 +03:00 • committed by GitHub
commit 4ed5a0d66e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
1-js/03-code-quality/03-comments/article.md
View file

@ -175,6 +175,6 @@ Good comments allow us to maintain the code well, come back to it after a delay
**Avoid comments:** **Avoid comments:**
- That tell "how code works" and "what it does". - 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). Comments are also used for auto-documenting tools like JSDoc3: they read them and generate HTML-docs (or docs in another format).