comment

You can use this function to display messages to the user, as well as variables to aid in debugging issues.

Version

1.3

Parameters

Parameter Type Description
cstr string Comment to display.

Notes

Use logMessage and logDebug functions instead.

Adds the message cstr to the message/debug window when the script executes. If you enable debugging (i.e., showDebug = true), the comment shows in the debug messages. If you enable messages (i.e., showMessage = true), the comment shows in the messages. If you do not enable debugging or messages, the comment does not display.

Use this function instead of directly assigning value to message variable in script control.

Example

true ^ comment(“calcValue is “ + calcValue) 
true ^ comment(“The building fees have been added automatically”)