Skip to content

Documenting a Gloop Service

A Gloop Service can be documented using comments. Aside from service-level comments, comments can also be added to individual Gloop Steps.

Commenting on a Gloop Service

To add comments to a service:

  1. Click any blank space on the step tree or click the table-shaped icon in the toolbar.
  2. Go to the Properties View.
  3. Click on the Comments tab.
  4. Type your comments.

Gloop Service Add Comments

Gloop Service Add Comments

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:

  1. Select a step.
  2. Go to the Properties View.
  3. Click on the Comments tab.
  4. Type your comments.

Gloop Service Step Add Comments

Gloop Service Step Add Comments

Alternatively, you can also edit step comments using the / key, like so:

Gloop Service Step Add Comments Shortcut

Gloop Service Step Add Comments Shortcut

Step comments are displayed next to the step in gray (green on Coder Cloud) 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.