What is the importance of documentation in computer programming?

Question

computer programming

Answer 1

I use documentation because I write so much code that I can't always remember exactly what every piece is doing. It's also good so that other people can edit your code without coming to you for questions.

There is (almost) nothing worse than having to fix or edit someone's code that doesn't have documentation. If you don't do it, people will hate you. If you do... people will LOVE you.

Answer 2

If you intend your program to be used, then it's good to leave instructions on HOW to use it.

You may want to write instructions for even yourself. For example, if you go on vacation for a year, and you had written into the program, a special hidden feature that took a gesture with your left hand and holding the center wheel of the mouse while tapping your right toe precisely once per second, you might forget that during the one year!

More seriously, if you intend the program for someone ELSE to use, and you CARE that they'll be able to take some advantage of it and it'll gain them something in their efforts, then you should leave instructions. Don't assume they have the same mindset as you. Write clear, concise documentation! (And don't be like Microsoft and tell them to "See their System Administrator"!)

Answer 3

Comments within web code are helpful to all that read them. Many times you may write code and not look at it at all for a long period of time by then you don't know why you wrote it that way in the first place.

Most legal contracts that I have seen though so far for web design and development restrict the purchaser from being able to modify or hire another to modify your copyrighted source code. However if you are not writing it under a contract then anything you write becomes property of your employer to edit as he sees fit. In the later case comments or other documentation may become very valuable should your employer decide to replace you.

Answer 4

To give some other person who might look at your code a reason as to why you did what you did.