Here’s a nice article Comments are More Important than Code by Jef Raskin on documenting your code.
The thorough use of internal documentation is one of the most-overlooked ways of improving software quality and speeding implementation.
3 thoughts on “Code Documenting Article”
Posting code? Use <pre> tags for VBA and <code> tags for inline.
“Many become so laconic that you have to understand the code to be able to interpret the comment. “
A great many manuals are this way: understood if known.
I have a brother who during the Y2K thingy was a maintenace programmer for an international pharmecutical company. He would have entire programs printed out and I would help him track down various aspects of code for his attention. I remember going through reems of printed code that was written in HP Basic for which the only line of code in the entire printout was “whatever will fit in a womans purse” – the only line of comment and it made absolutely no sense.
Another good reference:
Microsoft Coding Guidelines for Visual Basic:
http://msdn2.microsoft.com/library/h63fsef3.aspx
My favorite is Practical Standards for Microsoft Visual Basic by James Foxall ISBN 0-7356-0733-8
Availailable for as less as $4.00 through amazon
http://www.amazon.com/exec/obidos/tg/detail/-/0735607338/qid=1115023001/sr=1-1/ref=sr_1_1/104-6431679-3323157?v=glance&s=books