I've been working on a system to self-document my CFCs. Using additional metadata on fields and a custom property-definition mechanism I've been able to include property information, "throws" information and a few other things easily.
My hope is to create a tool which can condense all of this information into an XML packet for later transformation. Right now I'm hitting a block. My end immediate goal is to create HTML documentation. I would like to have a section of the documentation (perhaps several paragraphs) which describes the CFC and a section which lists the revision history of the CFC. I would like to do this in the CFC itself if possible (making the CFC truly self documenting) but am torn on how. I'm not completely comfortable with putting HTML directly into the "Hint" attributes (what if, later I wanted to output it some other way). For something like "Revision" were there can be many entries an attribute isn't the best thing anyway. I've considered adding a formatted comment the CFC with the information in it - but I'd like it more structured than that if possible (so that formatting can be applied later). I'm now considering putting a commented XML packet in the CFC containing the information - but this would mean that the packet would need to be edited by hand when adding a revision (not the worst thing in the world really). I'd also have to define that packet explicitly. The other option is to have a documentation page that has description and history and just use the introspection features to get property and method information... but that splits potentially important information from the CFC. Anybody else done anything like this? Any more ideas before I settle on something stupid? Thanks, Jim Davis ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:199411 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations & Support: http://www.houseoffusion.com/tiny.cfm/54
