Re: [CFCDev] Bean and CFC question

[Peter J. Farrell]

Jim Davis said the following on 1/20/2006 1:31 PM: I’m quite pleased with my self-documentation system.  If you take a look at the component catalogs here:   http://www.depressedpress.com/Content/Development/ColdFusion/DPLibraries/Index.cfm   Realize that each entry in the component catalog is generated dynamically from the component metadata (with additional information provided by custom <dodoc> tags embedded in the component).  Here’s the tutorial page that goes through how to do this:   http://www.depressedpress.com/Content/Development/ColdFusion/DPLibraries/Articles/Tutorial_DPCFCs/DPDocs.cfm   Ignoring any extra tags the components still self-document all properties (along with access and type information) and methods.  With the dpdoc information they can also document anything you wish: I document method return and exception information as well and authorship, versioning, datetime stamps, etc. Documenting is one the best things a developer can learn!  Jim, I applaud you for figuring out/designing a system that works for you. In regards to general CFC documenting in your library, personally I wouldn't find that too useful because we've standardized on version control (Subversion) at work.  That takes care of authorship, versioning, timestamps, version comments as well as a myriad of other things (we're moving to using Trac with Subversion as well at some point). Typically, I use a plain jane system for documenting methods in my CFCs. Ex:     <cffunction name="getStateProvinceByProperty" access="public" returntype="string" output="false"         hint="Returns the state/province string by property name.<br/>         Throws: addressService.invalidProperty if state/province property does not exist."> I find this to be enough in general.  Anyways, your system is pretty neat - especially for people not using a version control system. Best, .Peter -- Peter J. Farrell :: Maestro Publishing http://blog.maestropublishing.com Rooibos Generator - Version 2.1 Create boilerplate beans and transfer objects for ColdFusion! http://rooibos.maestropublishing.com/ - Member Team Mach-II - Member Team Fusion ---------------------------------------------------------- You are subscribed to cfcdev. To unsubscribe, send an email to cfcdev@cfczone.org with the words 'unsubscribe cfcdev' as the subject of the email. CFCDev is run by CFCZone (www.cfczone.org) and supported by CFXHosting (www.cfxhosting.com). An archive of the CFCDev list is available at www.mail-archive.com/cfcdev@cfczone.org