Specify comments in Javadoc format
The script editor supports some Javadoc tags. You can use Javadoc tags to display cleanly formatted hover help on parameters and variables and on calls to functions defined locally in the script.
You use Javadoc tags to:
- Enhance the content assist function. This enables you to obtain help on the functions that are defined within the script
- Enable the script editor to perform checks on the usage of the function
- Enables the use of other applications to render a version of the script for print or web page use
The script editor supports the following Javadoc tags:
- @param
- Documents a parameter declared in a function. Here is an example
of the syntax:
@param parameterName description. All parameters declared in a function should be documented with this tag. - @return
- Documents the information that is returned by a function. Here
is an example of the syntax:
@return description. There should be only one instance of the@returntag per function declaration. - @throws
- Documents the errors, which a function can throw. Here is an example
of the syntax:
@throws descriptionMultiple@throwstags can be used per function declaration. - @deprecated
- Indicates that the function is deprecated. Here is an example
of the syntax:
@deprecated description. The description is optional, however, it indicates why the function is deprecated and what should be used as an alternative.
Here is an example of a Javadoc tag that is used
in a comment:
// @deprecated This function is deprecated. To use the script editor syntax checking feature, the comment should be directly above the definition of the function.