gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added helpful tips about comment usage (#21168)

Browse Source
This commit is contained in:
kcrabtree
2018-11-26 00:15:27 -05:00
committed by Paul Gamble
parent e562625430
commit a4742d8a76
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
guide/english/javascript/tutorials/comment-your-javascript-code/index.md
View File

@ -18,3 +18,5 @@ a multi-line comment
(comment block)
*/
```
Comments are a great thing and are extremely valuable when used properly. As a professional developer, you'll often spend more time reading and working through other peoples code than writing your own. However, take care not to fall into the trap of over-commenting. The languages we use, like JavaScript, were created to be human readable. Take care not litter your code with unhelpful comments that simply restate what the code is doing. Instead, strive to write code that is self-documenting and leave comments explaining business logic, weird edge cases, etc.