> As I was doing my stuff today I had an interesting idea and > wondered what others thought. In a nutshell it would be cool > to be able to have a HINT attribute for every CFML tag for > VERY SHORT comments. I know this mixes comments within logic > but it would be great for certain things. For example: > > <CFPARAM NAME="myVar" DEFAULT="233" HINT="myHint"> > > I have an extensive db value key table with all sorts of > combinations and use its numeric key to represent its value. > So, in the above, 233 would equal some value and the HINT > would help the programmer to remember what the key was. Yes, > you could just as easily do <!--- myHint ---> but the above > idea is much cleaner. You could use HINT for all sorts of > brief notes... Thoughts?
The HINT attribute is useful for CFCs because you can see the values in the self-generated documentation. Beyond that, though, I don't see the utility of doing this instead of adding a comment. My problem with comments in general is that I often see them used to describe things that are self-describing, but not used when something needs to actually be described in detail. I think a HINT attribute would incline people toward that style of commenting, which is useless, although it wouldn't really be the fault of the attribute itself. Dave Watts, CTO, Fig Leaf Software http://www.figleaf.com/ Fig Leaf Training: Adobe/Google/Paperthin Certified Partners http://training.figleaf.com/ WebManiacs 2008: the ultimate conference for CF/Flex/AIR developers! http://www.webmaniacsconference.com/ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| Adobe® ColdFusion® 8 software 8 is the most important and dramatic release to date Get the Free Trial http://ad.doubleclick.net/clk;160198600;22374440;w Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:300036 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
