====== Boxed Comments ======

It’s a common practice to use boxed comments in TLA<sup>+</sup> specifications:

<code>
(**************************************************************)
(* This is a boxed comment.                                   *)
(* Such comment format is used in lots of specifications.     *)
(**************************************************************)
</code>

If you’d like to format your comments this way easily, you might want to install the [[https://marketplace.visualstudio.com/items?itemName=slysherz.comment-box|Comment Box extension]], and add the following settings to your ''%%settings.json%%'':

<code json>
"commentBox.styles": {
    "defaultStyle": {
        "commentStartToken": "(**",
        "commentEndToken": "**)",
        "leftEdgeToken": "(* ",
        "rightEdgeToken": " *)",
        "topEdgeToken": "*",
        "bottomEdgeToken": "*",
        "topRightToken": "**)",
        "bottomLeftToken": "(**",
        "capitalize": false,
        "ignoreInnerIndentation": false,
        "ignoreOuterIndentation": false,
        "removeEmptyLines": false,
        "textAlignment": "left"
    }
}
</code>

You can add multiple styles with different settings, add shortcuts to quickly apply formatting, etc. Please, refer to the [[https://github.com/slysherz/vscode-comment-box/blob/master/README.md|Comment Box documentation]] for the full feature list.