From bf64d3e8f37126a6d67ae7e60b6188a54d0b8117 Mon Sep 17 00:00:00 2001 From: Austen Pritchett <31089015+pritchettausten@users.noreply.github.com> Date: Sun, 28 Oct 2018 17:37:57 -0600 Subject: [PATCH] Added a couple lines (#20536) Mentioned that it's more difficult to go back through your code and comment it, rather than just comment it while you go. --- guide/english/documentation/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/guide/english/documentation/index.md b/guide/english/documentation/index.md index b831a9db4a..5aef954385 100644 --- a/guide/english/documentation/index.md +++ b/guide/english/documentation/index.md @@ -9,6 +9,8 @@ For example, if you happen to pass along your code to an absolute beginner, they It may become an extremely important idea to make a habit out of commenting your functions, loops, and declarations and treating comments as part of the source code, just as regular code should be. +Many developers have probably learned that it is much harder to go back through your code and comment it after you finish. It's always a good idea to label and comment your code as you go, so that you don't forget or mix up what certain variables or functions do. + ![An example of commenting in the real world](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg)