Comment
A note in the macro for whoever reads it. Nothing happens when it runs.
Comment text
Keyboard Maestro: Comment
Examples #
- SetupThe window must be in front before the clicks below
- Activate ‹app›
- Type “Hello”
Details #
A note that lives in the macro. It does nothing when the macro runs. Use it for a heading before a run of steps ("--- Setup ---"), for why a step is there, or for a to-do you will come back to.
The step runs as nothing. It makes no output and sets no variable. It still gets a row in the Trace, with no note, so step numbers line up with the editor.
In the editor the row looks like a note: italic, in a quieter colour. The first line of the text is the step's sentence. Give the step a label and the label becomes its title, with the text underneath.
BetterTouchTool's Comment action becomes this step too, with its text as text.
Parameters #
| Parameter | Type | Required | Values | What it does |
|---|---|---|---|---|
text | text | The note. It can run to several lines. An empty text is allowed, and the row then reads "Comment". |
Every step also accepts label, onFailure, timeout and dryRunSafe.
Gotchas #
The text is never evaluated. A
{{ name }}in it is shown as written and cannot fail the step.Turning the step off or deleting it changes nothing about how the macro runs.