Comment Buddy — Your Code’s Best Friend

A next-gen comment highlighter that adds color, structure, and personality to your code comments.
Perfect for devs who want clear, expressive, and visually organized code without sacrificing performance.

✨ Features

Comment Buddy enhances your code readability by intelligently styling specific comment patterns.
It works with all major languages — including JavaScript, TypeScript, Dart, C++, Java, Python, Go, and more!

🟡 Highlighting Patterns

Pattern	Example	Highlight Color	Description
`*`	`// * Important logic here`	🟡 Yellow	Highlights entire comment line for important notes
`!`	`// ! Critical error — fix now`	🔴 Red	Highlights entire comment for urgent issues
`TODO:`	`// TODO: add validation`	🟠 Gold	Highlights only the keyword `TODO:`
`FIXME:`	`// FIXME: handle API failure`	❤️ Carmine	Highlights only the keyword `FIXME:`
`[Text]`	`/// [HELLO WORLD] this is green`	🟢 Green	Highlights text inside brackets for emphasis
`@param`	`// @param name User’s display name`	🔵 Blue	Highlights the `@param` tag used in documentation

🧠 Why Comment Buddy?

🧩 Smart highlighting engine — Regex-powered but optimized for performance
🎨 Theme-aware colors — Looks great in both dark & light themes
🪶 Lightweight — Pure VS Code API, no heavy dependencies
⚙️ Extensible — Define your own keywords and colors
🔄 Instant updates — Reacts as you type, no refresh needed
🌍 Language agnostic — Works wherever //, #, or /* */ comments exist

⚙️ Configuration

Coming soon: full customization through VS Code settings!
Here’s a preview of what it’ll look like:

"commentBuddy.rules": [
  {
    "keyword": "*",
    "color": "#FFD700",
    "scope": "line"
  },
  {
    "keyword": "!",
    "color": "#FF4C4C",
    "scope": "line"
  },
  {
    "keyword": "TODO:",
    "color": "#FFD700",
    "scope": "word",
    "fontWeight": "bold"
  },
  {
    "keyword": "FIXME:",
    "color": "#DC143C",
    "scope": "word",
    "fontWeight": "bold"
  },
  {
    "keyword": "@param",
    "color": "#00BFFF",
    "scope": "word"
  },
  {
    "pattern": "\\[(.*?)\\]",
    "color": "#00FF7F",
    "scope": "inside"
  }
]

💾 Planned Options

Enable/disable specific patterns
Adjust opacity and font style
Add new keywords (like NOTE:, @returns, HACK:)
Sync settings across your team

🖥️ Supported Languages

Comment Buddy is designed to be language-agnostic, and supports any language that uses comments, including:

Language	Comment Style	Supported
JavaScript / TypeScript	`//`, `/* */`	✅
Dart / Flutter	`//`, `///`	✅
Python	`#`	✅
C / C++	`//`, `/* */`	✅
Java / Kotlin	`//`, `/* */`	✅
Go / Rust	`//`	✅
PHP	`//`, `#`	✅
Swift	`//`, `/* */`	✅
C#	`//`, `/* */`	✅
HTML / CSS / JSON / YAML	`<!-- -->`, `/* */`, `#`	⚙️ Partial

🧩 Example Showcase

// * Important: authentication must happen first
// ! Critical: never log credentials
// TODO: implement JWT refresh
// FIXME: handle expired tokens gracefully
// /// [HELLO WORLD] green text section
// @param username Name of the current user

Demo

🧱 Installation

From Marketplace

Open VS Code
Go to Extensions → Search “Comment Buddy”
Hit Install and reload

From VSIX file

code --install-extension comment-buddy-1.0.0.vsix

🔧 Commands

Currently, Comment Buddy auto-applies decoration rules. Future updates will add:

Comment Buddy: Refresh Decorations

Comment Buddy: Toggle Highlights

Comment Buddy: Export Settings

🧰 Developer Setup

If you want to contribute:

git clone https://github.com/yourname/comment-buddy.git
cd comment-buddy
npm install
npm run compile
code .

Then run the extension in debug mode (F5 inside VS Code).

🧪 Roadmap

[ ] Custom keyword & color configuration
[ ] Multi-theme adaptive coloring
[ ] Workspace-level sync
[ ] Markdown comment preview
[ ] Inline emoji icons 🎯

🤝 Contributing

We welcome pull requests and new ideas! Open an issue for any bug or color-scheme suggestion.

Fork the repo
Create a feature branch
Commit your changes
Submit a pull request 🚀

📄 License

Licensed under the MIT License. You’re free to use, modify, and share — just keep the credits intact.

💙 Author

Made with ☕ + ❤️ by Your Name

“Because your comments deserve some color too.” 🎨


---

### ⚡ Pro Tip
- Put a **`banner.png`** (1920 × 500) for a Marketplace banner.  
- Add **`images/demo.png`** (your screenshot) to show the highlights in action.  
- Name your icon `icon.png` (128×128 px) for the sidebar.  

---

Would you like me to now generate:
1. A matching **CHANGELOG.md**  
2. A clean **LICENSE (MIT)**  
3. And a short **Marketplace description + tags** (the text that appears before users even open your page)?

Comment Buddy

Kuntal Gain