Boxed comments

[Alexander-N]

The TLA+ Toolbox provides to functionality to box comments like this:

(***************************************************************************)
(* The algorithm is essentially derived by ensuring that this formula Inv  *)
(* is always true.                                                         *)
(***************************************************************************)

Looking through https://github.com/tlaplus/Examples this style of commenting seems to be pretty common, see this spec for an example by Leslie Lamport.

I'm using the Comment Box extension to get similar results with these settings:

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

Is this worth commenting on in the wiki?

[alygin]

It surely is. Here's a new page in the Wiki: Boxed Comments. Thanks for bringing this up!