Automate-Comment

Auto-Comment

Automate Your Documentation – Focus on Logic!

Table of Contents

About The Project
- Built With
Getting Started
- Installation
Usage

About The Project

Auto-Comment is a powerful VS Code extension designed to automatically generate comments for your code, saving you time and improving documentation consistency.

Whether you're working on solo projects, team collaborations, or open-source contributions, maintaining clear and structured comments is crucial—but writing them manually can be tedious.

🔝

Built With

🔝

Getting Started

✨ Never Lose Context Again! This extension automatically generates clear, concise comments for your code, ensuring developers (and future you 😉) understand it even after an eternity.

Installation

Install the extension from VS Code Marketplace
Ensure is installed.
Download your preferred model:

ollama run qwen3:0.6b

Alternativelly you can download any model and change the config int the package.json

"properties": {
   "autocomment.model": {
     "type": "string",
     "default": "qwen:0.5b",
     "description": "Model to use for generating comments (e.g., qwen:0.5b, deepseek-r1:latest, wizardlm2:latest, qwen3:0.6b)"
   }
 }

🔝

Usage

✨ Generate Smart Code Comments in 3 Easy Steps!

📌 Set Your Preferred AI Model

Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
Search and select "Set Model"
Choose any model (e.g., llama3, mistral, deepseek-r1) → Ensure the model is downloaded via Ollama first!
```
ollama pull [model-name]  # Example: `ollama pull llama3`
```