Monday, August 01, 2005

Proper Code Documentation

Documentation

Obligatory Humor Warning: The following post is made using a sarcastic and/or ironic voice. This post is intended solely for amusement purposes. If you are offended by humor/irony/sarcasm or have trouble distinguishing parody from fact, do not read the following post or the associated story. Click Here to avoid anything even remotely amusing.

Documenting your code is very important, although I tend to subscribe to the "less is more" camp. I prefer automated documentation templates where practicle. Unfortunately, I tend to do a bit of number 5 from the article. Keeping the design docs up to date can be a bit challenging as well, especially when we are always pressed for performance and price.

No comments:

Post a Comment