Table of Contents
@constant [<type> <name>]
The @constant tag is used to mark the documentation as belonging to a symbol that is a constant.
In this example we are documenting a string constant. Note that although the code is using the
can just as effectively be used on
Note that the example provides the type in a @type tag. This is optional. Also the optional @default tag is used here too, this will automatically add whatever the assigned value is (for example 'FF0000') to the documentation.