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

Added few advantages of documentation (#22416)

Browse Source
This commit is contained in:
raghavbhartia
2018-11-21 05:12:22 +05:30
committed by Manish Giri
parent 74a4b1175e
commit 1b97963972
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
guide/english/documentation/index.md
View File

@ -3,7 +3,9 @@ title: Code documentation
--- ---
## Code Documentation ## Code Documentation
Code Documentation is a way for developers to communicate the intent or reasoning behind a piece of code. Successfully 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.
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 also helps beginners understand the design choices that were made and they can get a high level understanding of the entire codebase without getting overwhelmed. 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 via external documentation, comments, appropriate variable names; even if they have very little knowledge of the language in use. 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.
@ -17,7 +19,7 @@ Think of Code documentation as a history textbook. It allows current developers
<!-- The article goes here, in GitHub-flavored Markdown. Feel free to add YouTube videos, images, and CodePen/JSBin embeds --> <!-- The article goes here, in GitHub-flavored Markdown. Feel free to add YouTube videos, images, and CodePen/JSBin embeds -->
#### More Information: #### More Information
<!-- Please add any articles you think might be helpful to read before writing the article --> <!-- Please add any articles you think might be helpful to read before writing the article -->