We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 95597b8 commit 8aca352Copy full SHA for 8aca352
1-js/03-code-quality/03-comments/article.md
@@ -175,6 +175,6 @@ Good comments allow us to maintain the code well, come back to it after a delay
175
**Avoid comments:**
176
177
- That tell "how code works" and "what it does".
178
-- 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.
179
180
Comments are also used for auto-documenting tools like JSDoc3: they read them and generate HTML-docs (or docs in another format).
0 commit comments