Generates a clean comment box using ascii box drawing characters around a selection.
Inspired by this prototype: https://prototypes.polymermallard.com/docblock/index.html
Example
#
# ┌────────────────────────────────────────────────────────────────────────────┐
# │ │
# │ This is a comment of documentation (Doc Block) │
# │ │
# │ @param Request $request │
# │ @return Response │
# │ @throws \Exception │
# │ │
# └────────────────────────────────────────────────────────────────────────────┘
#
Configuration
The plugin defaults to single line box drawing and 80 characters wide. You can change these in your settings:
"box-comment.chars": {
"tl": "╔",
"tm": "═",
"tr": "╗",
"l" : "║",
"r" : "║",
"bl": "╚",
"bm": "═",
"br": "╝",
"dl": "╠",
"dm": "═",
"dr": "╣"
},
"box-comment.length": 60
Usage
Three commands exist:
- Create comment box (via config)
- Create comment box (80 wide)
- Create comment box (120 wide)
The configuration setting is a numerical value for box-comment.length.
Key Bindings
For Mac/PC: shift+cmd+; / shift+alt+; will run Create comment box (via config)
Special Features
Dividers are supported by using two hyphens: --
Lorem ipsum dolor sit amet
--
Consectetur adipiscing elit
Becomes:
// ╔══════════════════════════════════════════════════════════╗
// ║ Lorem ipsum dolor sit amet ║
// ╠══════════════════════════════════════════════════════════╣
// ║ Consectetur adipiscing elit ║
// ╚══════════════════════════════════════════════════════════╝
Release Notes
0.1.7
- Ability to uncomment entire blocks back to normal
- Use block comments rather than line blocks
box-comment.indentation setting for pre-indentationbox-comment.length setting for total line lengthbox-comment.linebreak.before boolean flagbox-comment.linebreak.after boolean flag
0.1.2
- Added keybindings by default.
0.1.1
- Change various graphics and README data
0.1.0
0.0.1
- Initial creation of Box Comment
Packaging
We are using vsce to package and publish. yarn vsce publish
