Tags

Most information about the tag is extracted from comment variables. A comment variable is defined by putting "@@variablename:" followed by the variable value in a ColdFusion comment. A comment can contain as many of these variables as you like.

Attribute information is parsed out from cfparam'd attribute variables and any comment IMMEDIATELY following the cfparam tag.

@@hint

A short description of what the tag does. Used in CFEclipse as a tooltip.

@@description

A longer explanation of the tag. Will be used in HTML documentation. NOTE: to break a paragraph use a double line break.

@@single

A boolean value that indicates whether this is a single element tag (i.e. <abcd>) or not (i.e. <efgh>...</efgh>. Defaults to true.

@@xmlstyle

If this is a single tag, this boolean value indicates whether the tag needs to be used XML style, i.e. <abcd />.

CFParam@name

The attribute variable will be extracted as the tag attribute name.

CFParam@type

This will be extracted as the tag attribute type.

CFParam@default

This will be extracted as well. If it isn't defined, the tag attribute is flaged as required.

CFParam @@attrhint

A short explanation of the tag attribute. Used in CFEclipse as a tooltip.

If the comment doesn't contain any "@@" strings, the entire comment content is used as the hint.

CFParam @@options

A list of the values supported by the attribute. Used in CFEclipse to provide a dropdown list of options.