From a4742d8a76dc14d294a27d7e035b9c3203e37711 Mon Sep 17 00:00:00 2001 From: kcrabtree Date: Mon, 26 Nov 2018 00:15:27 -0500 Subject: [PATCH] Added helpful tips about comment usage (#21168) --- .../javascript/tutorials/comment-your-javascript-code/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/guide/english/javascript/tutorials/comment-your-javascript-code/index.md b/guide/english/javascript/tutorials/comment-your-javascript-code/index.md index 8bd3c8e1f1..d0f00d9269 100644 --- a/guide/english/javascript/tutorials/comment-your-javascript-code/index.md +++ b/guide/english/javascript/tutorials/comment-your-javascript-code/index.md @@ -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.