https://github.com/pouyakary/comment

A KFCS plugin for Visual Studio Code, So that you can shape anything into KFCS section comment with just ⌘y and ⌘l
https://github.com/pouyakary/comment

comment kary-comments karyfoundation kf-coding-system readability vscode vscode-extension

Last synced: 3 months ago
JSON representation

A KFCS plugin for Visual Studio Code, So that you can shape anything into KFCS section comment with just ⌘y and ⌘l

• Host: GitHub
• URL: https://github.com/pouyakary/comment
• Owner: pouyakary
• License: mpl-2.0
• Created: 2016-07-10T22:39:56.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-22T17:08:49.000Z (11 months ago)
• Last Synced: 2024-03-22T18:32:55.956Z (11 months ago)
• Topics: comment, kary-comments, karyfoundation, kf-coding-system, readability, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=karyfoundation.comment
• Size: 1.24 MB
• Stars: 20
• Watchers: 1
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Comment 6 ✨

With ❤️ by Dragon's Lover.

Comment 6 is a way to decorate your code with titles and separator lines to organize the portions of a file. I have always had a really hard time to keep track of where a function starts and where it ends. While there are millions of ways to tackle the problem, I simply wanted to have what I had in notebooks: good old lines.

With Comment 6 you can simply create these headings:

![Screen recording of comment generation in Comment 6](https://user-images.githubusercontent.com/2157285/196059184-79542059-88da-45ff-a7a5-87cd804939bf.gif)

And edit them whenever you want:

![Screen recording that shows the editing of a comment in Comment](https://user-images.githubusercontent.com/2157285/196059190-7adef113-05ad-4727-bbc2-dd84a860c146.gif)




> **🧨 LOOKING FOR THE LEGACY VERSION?** 


> Comment 6 is a fully rewritten version. Every line of it is fully brand new. If you wish, you can download the last version of Comment V from [it's GitHub releases](https://github.com/pouyakary/comment/releases/tag/v11.2.0).




## Notes 💡

- **Indentation Matters** — The way comment works is that you pick an empty line and indent as far as you wish your comment is going to be indented. You then start typing the comment and then use the menu or keybindings to generate the comment. The size and indentation of your resulting comment is determined by that indentation.

- **Only Use These Comments To Create Logical Parts In Your Codes** — Try to separate, types, functions, classes, the parts of the classes. The More organized you are the better.

- **Adopt The Clarity Style To Your Codes** — Try to have files that are minimal as possible. Have one class per file if you can. When a file move to more than a few hundred lines try to break it into different files. Try to write the best code you can. It always pays the efforts.

## Keybindings

| Comments                      | Keybindings                  |

| ----------------------------- | ---------------------------- |

| 🔧 Creating Title Comment     | `alt` + `y`                  |

| 🔨 Creating Separator Comment | `alt` + `l`                  |

| 🧨 Editing Title Comment      | `ctrl` + `alt` + `cmd` + `y` |

> **NOTE 💡** 
 These keybindings are chosen such that they are both easy to use within QWERTY and Dvorak layouts.