greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Reworded couple of lines in index.md (#19313)

pull/19319/head
Praveen Murali 2018-10-15 21:35:02 +05:30 committed by Jonathan Grah
parent 0e986233e2
commit 7cd6a1fb32
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
client/src/pages/guide/english/documentation/index.md
View File

@ -3,11 +3,11 @@ title: Code documentation
--- ---
## Code Documentation ## Code Documentation
Code documentation is a way developers write their code to create the best versions of their functions possible. Code Documentations lets the newbie to get comfortable with the custom of the particular module, function 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 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.
For example, you should be able to pass along your code to an absolute beginner and they should be able to follow along through comments, appropriate variable names and structuring 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 through comments, appropriate variable names and that means structuring the code in a spaced, readable manner.
It may become an extremely important idea to make a habit out of commenting your functions, loops, and declarations and treating comments as a part of the source code, just as regular code should be. 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.
![An example of commenting in the real world](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg) ![An example of commenting in the real world](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg)