O'Reilly logo

Adobe ColdFusion 8 Web Application Construction Kit, Volume 1: Getting Started by Charlie Arehart, Raymond Camden, Ben Forta

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Documenting ColdFusion Components

As your ColdFusion Component collection grows, so will the uses you find for them. So will the number of developers who will want to take advantage of them, assuming you’re working with other developers. As such, it is really important to document your ColdFusion Components, explaining what they do, what each method does, and what you expect passed to any arguments.

Documenting ColdFusion Components is so important that self-documenting features are built right into the tags used to create them. Each of the CFC tags used in this chapter, <cfcomponent>, <cffunction>, and <cfargument>, take an optional attribute named hint. As you can see in Listing 11.12, the hint attribute has been used to add little snippets ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required