Commenting your Models

Comment boxes work like digital sticky notes in your model. Use them to keep notes on your analyses, explain the model or document why you made certain modeling decisions.

Add or edit a comment

To add a comment, click Comment in the toolbar and place the comment box in your model.
To edit a comment, double-click it.

The Edit comment dialog: Markdown text at the top, the attached image file with Insert and Delete below it, and the rendered preview with a book cover

Format text

Comment boxes support Markdown syntax. For example:

# Heading Level 1

## Heading Level 2

### Heading Level 3

**Bold Text**
_Italic Text_

For numbered lists, start lines with 1., 2., 3.. For bullet points, use - or *.

Add a link

Use the Markdown link format. It becomes a clickable link in the comment box:

[SmartPLS software link](https://www.smartpls.com)

Add an image

First add the image file to the comment with the Add image button. Then embed it with this Markdown format, where smartpls.jpg is the image file name:

![](image:smartpls.jpg)

Images can add visual context or additional analysis insights to your documentation.

Tips for useful comments

Be concise: note key information without crowding the box.
Use formatting sparingly: highlight only the most important points, so the comment stays easy to read.
Use lists for steps or instructions.