Associates a description with a module, or with any statement within the module.
@description text
text: Text that will be displayed in association with the specified module or statement.
The @description documentation tag associates a description with a module, or with any statement within the module. Only one @description tag can be associated with a module or a statement. If the description is associated with a module, the @description tag must appear in the same tag block as the @module tag. Avoid long description text strings as they may be truncated.
The following example provides a description of the MyModule module:
//!@module MyModule //!@description This is a further module description
This example provides a description of the query that follows it:
//!@description pre-connect message confirmation
INSERT INTO MsgOut
SELECT
"OK",
"Pre-Connect"
FROM
MsgIn
WHERE
MessageType = "OK?" AND Data="Pre-Connect";