Documenting a service
A service can be documented using comments. Aside from service-level comments, comments can also be added to individual Gloop steps.
Commenting on a service
To add comments to a service:
- Open the Properties view by clicking on any blank space on the step tree or by clicking the table-shaped icon in the toolbar.
- Click on the Comments tab.
- Type your comment.
Also used in documenting Gloop API endpoints
A service-level comment will automatically be used to document the API where the service is used when it is exposed via a Gloop REST or SOAP API.
Commenting on steps
Adding comments to individual steps is similar:
- Select a step.
- Open the Properties view by clicking the table-shaped icon in the toolbar, if it isn't open yet.
- Click on the Comments tab.
- Type your comment.
Use the shortcut to quickly edit step comments
You can also edit step comments by selecting the step and pressing the key, like so:
Step comments are displayed next to the step in gray prefixed with //
when short, or surrounded
with /*
... */
when long. Long comments will not show entirely but when hovering over a step, they will appear
as a tooltip.