⚠️ Important Release Note for the Version 10
Within the version 10 and above, the style of comments
have been changed. Since there are many code bases that
use the legacy version. You can include this snippet
within your settings.json or inside the
.vscode/settings.json within your project so that
anyone on the codebase can benefit.
"comment": {
"legacy": false
},
What is this?
Comment V is a Kary Comments Generation Tool. Kary Comments are a part of the Kary Coding Standards designed to bring richer layouts to the code. These comments are designed to work inside of that specifcitaion and with their own respective rules. So if you don't know them please read these articles before dowloading this extension.
── ─── Section Comment ────────────────────────────────────────────────────────────
── ───────────────────────────────────────────────── Reversed Section Comment ─────
── ────────────────────────────────────────────────────────────────────────────────
──
── ──────────────────────────────────────────────── I ──────────
── :::::: F L A G : : : : : : : :
── ──────────────────────────────────────────────────────────
──
──
── ─── INDENTATION LEVEL 1 ────────────────────────────────────────────────────────
──
──
── ─────────────────────────────────────────────────── LEVEL 1 ENDING COMMENT ─────
──
──
── ─── INDENTATION LEVEL 2 ─────────────────────────────────────────
──
──
── ──────────────────────────────────── LEVEL 2 ENDING COMMENT ─────
──
──
── INDENTATION LEVEL 3
──
── • • • • •
── ─────────────────────────────────────────────────────────────────
── ────────────────────────────────────────────────────────────────────────────────
How to use?
Comment V is content-aware so you don't have to choose your section type of comment. Comment uses Kary Section Comment Width 80, Kary Section Comment Width 60 and Kary Section InSection Comment for start of your part and Kary Line Comment Width 80, Kary Line Comment Width 60 and Kary Separator Comment for end of your section. What you have to do is to specify if the comment is start or the end of the section.
| Comments |
Keybindings |
Additional Information |
| Flag |
alt + shift + y |
You'll have to also give it the index number |
| Section Header |
alt + y |
Section Comment for Indentation less than 2 and InSection comment for the rest |
| Reverse Section Start |
alt + m |
same as section comment |
| Section End |
alt + l |
Line Comment for Indentation less than 2 and Separator comment for the rest |
NOTE
These keybindings are chosen such that they are both easy to use within QWERTY and Dvorak layouts.
NOTE
To enable legacy mode:
"comment": {
"legacy": false
},
