AI-powered VS Code extension that automatically generates professional, readable, and multi-language code comments for selected code or entire files with just one click using Google's Gemini API.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Supercharge your coding workflow with AI Auto Commenter, a powerful VS Code extension that leverages Google's Gemini API to automatically generate professional, readable, and multi-language code comments.
Features
Comment Selected Code: Select any piece of code and instantly get a detailed comment block explaining its functionality, parameters, and return values.
Comment Entire File: Let the AI analyze your entire file and intelligently add comments where they are most needed, improving overall code readability and maintainability.
Multi-Language Support: Works with a wide variety of programming languages like JavaScript, TypeScript, Python, Java, C++, and more.
Powered by Gemini: Utilizes the advanced capabilities of Google's Gemini Pro model for high-quality, context-aware comments.
How to Use
Install the Extension: Find "AI Auto Commenter" in the VS Code Marketplace and click Install.
Set Your API Key:
Open VS Code Settings (Ctrl + ,).
Search for "AI Auto Commenter".
Enter your Google Gemini API Key in the auto-commenter.geminiApiKey field. You can get a free API key from Google AI Studio.
Generate Comments:
For Selected Code:
Select a function or block of code.
Press Ctrl+Shift+C (or Cmd+Shift+C on Mac).
Alternatively, open the Command Palette (Ctrl+Shift+P) and run "AI: Auto Comment Selected Code".
For Entire File:
Open the file you want to comment.
Open the Command Palette (Ctrl+Shift+P) and run "AI: Auto Comment Entire File".
Configuration
auto-commenter.geminiApiKey: Your personal API key for the Google Gemini API.
Contributing
Contributions are welcome! If you have ideas for new features or find a bug, please open an issue or submit a pull request on our GitHub Repository.
