Sunday, December 27, 2009

Why is documentation important in programming?

Documentation is very important in programming. When you're in the midst of writing code, everything makes sense in your head and flows out with complete understanding. However, going back to the same code later, when your mind is now focused in a different area, it may not be so clear as to why you wrote the code or the way in which you wrote it. Also, if you are currently working on a team with other developers, of if one day someone else may be working on your code, your documentation will make it clear to these people your intentions in writing what you did and the way in which you did it.





Another thing to keep in mind with documentation is that it can be taken too far. It is important to write code that is self documenting, that is, that someone that is not familiar with the code can tell what the code is doing from just looking at the code itself. Any other documentation is meant to support this in clearing up any ';why'; questions that may exist after looking at the code.Why is documentation important in programming?
Mike read this





http://myweb.stedwards.edu/laurab/help/p鈥?/a>Why is documentation important in programming?
Because sometimes you can't remember what you did and what it does, so you can refer back to your programming with ease.
read it in wikipedia


http://en.wikipedia.org/wiki/Literate_pr鈥?/a>

No comments:

Post a Comment