Carrot is a Visual Studio Code extension that transforms ordinary code comments into unobstrusive Carrot Comments with interactive, persistent Carrot Notes attached. Instead of cluttering your code with inline comments, Carrot lets you convert them into Carrot Comments that appear as icons in the editor gutter. Hovering over the line next to an icon shows the code comment and allows opening the associated Carrot Note, where you can expand your thoughts. Carrot Notes provide a rich text editor and a free-draw feature that allows you to sketch and visually structure your notes.
Features
Unobtrusive Code Comments: Hide your comments behind a Carrot Icon.
Format your Carrot Comments: Write your comments in Markdown and see formatted text in your hover messages!
Format your Carrot Notes: Use the rich text area in your Carrot Notes to format your notes!
Multi-media: Create drawings in your Carrot Notes with the whiteboard feature.
Multi-media: Store images in your Carrot Notes.
Delete your Carrot Comments.
You can find the keybinds at anytime in the sidebar.
Commands
To create a Carrot Comment, highlight the code comment and press:
On Windows: ctrl + alt + c
On MacOS: command + option + c
To format your Carrot Comments, write in Markdown syntax. For multi-line comments begin each new line with //.
To access the associated Carrot Note, click Open Note.
To format your Carrot Notes, use the rich text editor provided.
To create drawings in your Carrot Notes, use the whiteboard feature provided.
To attach images to your Carrot Notes, select/copy and paste any image into the rich text editor.
To delete a Carrot Comment, highlight the line next to the Carrot Icon and press:
On Windows: ctrl + alt + d
On MacOS: command + option + l
Beware: This permanently deletes the Carrot Comment.
Extension Settings
This extension contributes the following settings:
myExtension.enable: Enable/disable this extension.
keybindings command + option + c / ctrl + alt + c to create a Carrot Comment
keybindings command + option + l / ctrl + alt + d to delete a Carrot Comment
Known Issues
Text button in whiteboard feature is inconsistent in showing text.
Release Notes
1.0.0
Ready for production: First official release.
Bug fixes and Readme.md enhancement with gifs.
