Comments & Descriptions

It is good practice to comment and describe rules, rule sets and repositories in Tomorrow Software. Comments and descriptions help explain the purpose of the design and why it was designed in the specific manner. It also makes life easier for the next rule writer, reducing the overhead associated with association and learning.

Rule Commenting

Each rule should be commented with an appropriate description that explains what it does. Rule comments could begin with a verb that briefly describes the activity.

Rules Commenting

Comments can also be added in the rule set page as a floating text box, with the “Comment” rule. This can be used to describe the purpose of specific rule activity on the page, or detailed technical information regarding the rule set.

Comment floating text box

Rule set and repository descriptions

Rule sets and repositories should be given an appropriate description as to help understand their purpose.

Rule set example:

Rule Info tab

Repository example:

Repository Description example