One Line of Code, Four Lines of Comments

Nov 10, 2005 15:18

Microsoft may finally have found a way to motivate programmers to comment their code. If the comments are enclosed in certain XML tags, a wonderful program will parse them and create a Windows Help file. The more tags you use, the better the help file is. As everything, this is both a blessing and a curse.

Blessing: Programmers don't have to fire up a word processor.
Curse: Programmers have to document THE HELL out of their code.

Check back next week; I expect I'll still be documenting all the code that I've written in the past year and a half.

entries, geeky

Previous post Next post
Up