For what it’s worth most version systems can plug meta information into variables set on the page.

 

We actually use Star Team at the office and it’s Star Team (no the developer) that fills in the dpdoc tag information for those tags it can fill in.  So once the variables are set on the templates the documentation update process is automated via StarTeam (for that information it knows) but we still get generated documentation for our team website.

 

Nothing on the DepressedPress site does this however… I’m still doing that all by hand since I’ve been too lazy to set up a personal source control system.  But it’s definitely on the (long and growing) list of things I need to do.

 

Jim Davis

 

 


From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Peter J. Farrell
Sent: Friday, January 20, 2006 2:47 PM
To: [email protected]
Subject: Re: [CFCDev] Bean and CFC question

 

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.

----------------------------------------------------------
You are subscribed to cfcdev. To unsubscribe, send an email to [email protected] 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/[email protected] ----------------------------------------------------------
You are subscribed to cfcdev. To unsubscribe, send an email to [email protected] 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/[email protected]

Reply via email to