Code Notes

A Visual Studio Code extension that allows you to attach notes to specific code segments in your files.

Features

• Add contextual notes to any code segment
• Notes stay attached to your code even when it moves or changes slightly
• View all notes in a dedicated panel
• Search through your notes by content, file path, or code
• Sort notes by creation date
• Quickly navigate to the code associated with a note

How to Use

Adding a Note

1. Select a piece of code in your editor
2. Right-click and select "Add Code Note" from the context menu, or use the keyboard shortcut Ctrl+Alt+N (Cmd+Alt+N on Mac)
3. Enter your note in the input box that appears
4. Press Enter to save the note

Viewing Notes

• Click on the Code Notes icon in the Activity Bar to open the Notes Panel
• Alternatively, use the command "Code Notes: Show All Notes" from the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)

Managing Notes

• Navigate to code: Click on any note in the Notes Panel to jump to the associated code
• Edit a note: Click the "Edit" button on a note
• Delete a note: Click the trash icon on a note
• Search notes: Use the search box at the top of the Notes Panel
• Sort notes: Click the "Toggle Sort Order" button to switch between newest and oldest first

Code Lens Integration

• Notes appear as CodeLens annotations above the associated code
• Click on a CodeLens annotation to view, edit, or delete the note

Tips

• Notes will stay attached to your code even if you make small changes to it
• If the code changes significantly or is deleted, the note will be marked as "Not Found"
• You can still access and manage "Not Found" notes through the Notes Panel

Requirements

• Visual Studio Code version 1.60.0 or higher

Extension Settings

This extension doesn't add any VS Code settings yet.

Known Issues

• Currently only supports JavaScript, TypeScript, JSX, and TSX files

Release Notes

1.0.0

• Initial release of Code Notes

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!