How do you comment/document your CFCs?
ColdFusionThe "CFC Component Doc Static Generator" posted by Christopher Wigginton is a true gift to the CF community. I hope you didn't miss it.
Although I've been aware of them since they were first available, I haven't really found much use for the introspection docs, viewable in the CFC Explorer of the CF Admin. I always thought is was *cool* and all, but normally I'm just coding along, and expect (or at least hope against hope) anything non-obvious is commented - in a readable way.
So, that brings up the point of this entry... earlier today I was discussing with my fellow developers that I never really liked to use the "hint" attribute of cfcomponent or cffunction, because it's very difficult to read. And I asked if any of them actually used the CFC Explorer, and they all said, "no". So, I pointed out that "normal" comments above any code in the CFC that is doing something non-obvious is my preferred method to comment/document CFCs. They had no arguments to that...
But I'm curious how others feel on this matter...?
For me, the "CFC Component Doc Static Generator" may change my mind, since it's a more convenient (and fast) way to access the docs, since they're static and not necessarily tied to the CF Admin. We'll see if it changes the way I work with CFC in the near future...






Loading....