Looking for more information on how to do PHP the right way? Check out PHP: The Right Way

Marco Tabini's Weblog:
Eat the Document
Sep 01, 2004 @ 12:23:41

Over on Marco Tabini's Weblog today, there's a new posting that might hit close to home with quite a fe developers out there - a discussion on code documentation.

If we were to take a show of hands, I'm sure that everybody's would go up were I to ask "how important is documenting your code?" Change that question to "how many of you properly document your code," though, and I'll bet a lot of hands will immediately go down.

The truth, in my experience, is that most people don't write a lot of documentation for their code. This goes all the way from comments to full-fledged manuals - and it includes applications that go from the simple and unimportant to complex and critical.

The posting continues on, pondering the need for lengthy documentation (such as some programming groups subscribe to) versus the tried-and-true "dive right in and hack away" method.

tagged:

Link:


Trending Topics: