A KFCS plugin for Visual Studio Code, So that you can shape anything into KFCS section comment with just ⌘y and ⌘l
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
test
.gitignore
.vscodeignore
Icon.png
LICENSE
README.md
comment.js
dictionary.js
jsconfig.json
package.json
roman.js

README.md

Comment V for Visual Studio Code

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.

Supported Comments


──
── ──────────────────────────────────────────────── 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.

Whats new?

  • 7.0.0 — This is a big release. The engine is now tailored to be more flexible and generate really better comments for Python and similar indentation-sensative languages.
  • 6.1.0 — A problem with Line comments regarding the spacings was fixed and also based on a request six new characters are now accepted on the comment text: -, +, :, @, ?, and !
  • 6.0.0 — After a lot of requests... It now supports Multi line comments! So languages like C, CSS, HTML, XML... are all now supported!
  • 5.0.1 — GLSL Language Support Added.
  • 5.0.0 — Reverse Section Comments are now supported.
  • 4.0.6 — SQL language is now supported.
  • 4.0.5 — Jison Language is now supported.
  • 4.0.4 — yUML language is now supported.
  • 4.0.3 — Nearley.js language is now supported.
  • 4.0.2 — PEG.js language is now supported.
  • 4.0.1 — Supporting Uno and Fish languages.
  • 4.0.0 — Now having the awesome context menus.
  • 3.0.10 — Line comment improvements.
  • 3.0.7 — YAML is now supported.