Freelance Forums

How much do you do it? I try to document a lot but feel that sometimes all the doc info gets in the way.

I prefer to just comment my code.. I suppose if you're planning on releasing your code as an open source application, code documentation is much more important to show programmers how you did things so when they have their own ideas, they can quickly know how to add their own fixes.

But other than the above senerio, I don't believe code documentation is very necessary. As long as you use proper naming of files, a proper programming structure, and some decent comments, any small changes an off-site programmer may need to make can be figured out from that.

Hope this helped!

Thanks for the reply. I agree with what you are saying but I feel that sometimes, having the extra information might help sometime down the line when you do need to modify the code.

I guess the real question I should have asked is. Would you rather have more doc or less doc in the code?

Hi..
I have read your post and the information which you share regarding code documation...
Thanks for sharing the post..