From 27e93542188c5342940aca9d0ac46c5f7fddadf6 Mon Sep 17 00:00:00 2001 From: Jeff Innes Date: Mon, 29 Oct 2018 18:40:14 -0700 Subject: [PATCH] Fixed grammar and content issues (#20364) Edited content to more specifically address the topic. --- guide/english/documentation/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/guide/english/documentation/index.md b/guide/english/documentation/index.md index 5aef954385a..9e3a841e54f 100644 --- a/guide/english/documentation/index.md +++ b/guide/english/documentation/index.md @@ -3,11 +3,11 @@ title: Code documentation --- ## Code Documentation -Code documentation is a way developers write their code to create the best versions of their functions possible. Code Documentation lets the newbie to get comfortable with the customs of the particular module, functions etc for a particular programming language. It is always recommended to go with the documentation before debugging your code, this helps you to debug effectively. +Code Documentation is a way for developers to communicate the intent or reasoning behind a piece of code. Successfuly documented code helps other developers get comfortable with the logic and use of the particular module, functions etc for a particular programming language. It is generally recomended that you document your code as you develop it; this way nothing is forgotten when development is being wrapped up. -For example, if you happen to pass along your code to an absolute beginner, they should be able to follow along through comments, appropriate variable names and that means structuring the code in a spaced, readable manner. +For example, if you happen to pass along your code to an absolute beginner, they should be able to follow along via external documentation, comments, appropriate variable names; even if they have very little knowledge of the language in use. -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. +It is a good idea to make a habit out of commenting your functions, loops, and declarations and treating comments as part of the source code. 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.