This extension provides commands and configuration to insert customisable comments boxes and blocks.
Features
| Feature |
Command |
| Create comment boxes/blocks using user-defined styles and some defaults. |
Box and Block Comments: Add Comment (Choose Style) |
| Set a user-defined default style. |
Box and Block Comments: Set Default Style |
| Quickly create a comment with a commonly-used style using default style setting. |
Box and Block Comments: Add Comment (Default Style) |
Extension Settings
Include if your extension adds any VS Code settings through the contributes.configuration extension point.
For example:
This extension contributes the following settings:
vscode-box-and-block-comments.defaultStyle: The name of the style to use with Box and Block Comments: Add Comment (Default Style).vscode-box-and-block-comments.styles: Array of styles (see below).
Adding styles
Add the following to your settings.json, and create you own styles with the same parameters:
"vscode-box-and-block-comments.styles": [
{
"name": "Rectangle Box",
"description": "Top: ┌────┐ Bottom: └────┘ Left/Right: // │ │ (// Comments)",
"topLeft": "// ┌",
"topRight": "┐",
"leftEdge": "// │",
"rightEdge": "│",
"bottomLeft": "// └",
"bottomRight": "┘",
"topEdge": "─",
"bottomEdge": "─",
"minimumWidth": 6
},
{
"name": "Dash Block",
"description": "Top/Bottom: //----// Left/Right: // // (// Comments)",
"topLeft": "//",
"topRight": "//",
"leftEdge": "//",
"rightEdge": "//",
"bottomLeft": "//",
"bottomRight": "//",
"topEdge": "-",
"bottomEdge": "-",
"minimumWidth": 6
}
],
Release Notes
1.0.0
- Comment insertion (choose style + default style).
