I'm pretty conscientious about documenting my open-source work. Probably moreso than most folks... But then my documentation is also all web-ready and a test-case for the framework. The majority of it does end up being "language"-reference (documentation for individual tags, functions and CFC's) but there are both beginner and advanced tutorials in the core docs and I provide an overview doc with plugins. (Granted, there's only one publicly available plugin currently.) But I produce such a large volume of code that it would be impossible for my documentation to be flawless.
> poorly formatted code + no documentation or comments = > bad; > poorly formatted code + bad documentation or comments = > bad; > [poorly formatted code + good documentation or comments = > bad;]* > [well formatted code + no documentation or comments = > GOOD;]* > well formatted code + bad documentation or comments = > bad; > well formatted code + good documentation or comments = > good; > where > well formatted code = minority; > poorly formatted code = majority; > no OR bad documentation or comments = majority; > *[good documentation or comments = yeah right;] > -----Original Message----- > From: Jeffry Houser [mailto:[EMAIL PROTECTED] > Sent: Tuesday, May 10, 2005 7:42 AM > To: CF-Jobs-Talk > Subject: SPAM-LOW: RE: What makes a programmer look low > level > At 10:39 PM 5/9/2005, you wrote: >>Not all documentation is good; in fact, most is bad (in my >>experience.) > In my experience, most is non-existent. But, I've never > had a problem > with documentation that is there. And I still have a hard > time imagining a > time where comments make it hard to follow the logic of > code, no matter how > poorly written the documentation is. s. isaac dealey 954.522.6080 new epoch : isn't it time for a change? add features without fixtures with the onTap open source framework http://www.fusiontap.com http://coldfusion.sys-con.com/author/4806Dealey.htm ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:11:2590 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/11 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:11 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.11 Donations & Support: http://www.houseoffusion.com/tiny.cfm/54
