...
Info | ||
---|---|---|
| ||
CFEclipse IDE FarCry coding dictionaries: Installing the dictionary:
|
Tip | ||
---|---|---|
| ||
You can use the dictionary with CF Builder. Builder only accepts a single dictionary per version, so you will need to create a merged file of both CF? + FarCry xml files. Here is one I prepared earlier: |
Documentation Guidelines
To ensure the documents are complete, the following guidelines should be followed when writing or updating code. By making sure all the relevant comments and metadata attributes are in place, we can automate the upkeep of various documentation sources.
...
Attribute | Description |
---|---|
bDocument | A boolean value that indicates whether the component should be included in documentation. Defaults to false. |
bDeprecated | A boolean value that indicates whether the component is considered deprecated in favor of other code. Defaults to false. |
scopelocation | If the component is consistently available in one of the scopes, this attribute contains the path. |
...
Variable | Description |
---|---|
description | A longer explanation of the tagfunction. Will be used in HTML documentation, and can contain HTML code. |
examples | Examples of tag function usage. Will be used in HTML documentation, and can contain HTML code. |
...
Components with a scopelocation defined, and their functions, are automatically added to the scope variables.
...