<h1>HOW TO USE!!!</h1>
<p>This tool features using Ollama and VsCode together.
<img src="https://raw.githubusercontent.com/Yuvadi29/Ai-Comment-Generator/fda6f915656a5d875902afedd6e042b5e6d44aba/image.png" alt="Image"></p>
<h2>Features</h2>
<p>This is basically a very simple comment generator for your project when you want to generate a comment for your file and you don’t want to 😆. So let AI do it for you 🤖.</p>
<h2>Requirements</h2>
<ol>
<li>NodeJs and npm installed</li>
<li>A machine capable of using LLMs using Ollama</li>
</ol>
<h4>Setup</h4>
<ol>
<li>Install Ollama for your operating systems from the Ollama’s official website: <a href="https://ollama.com/download" target="_blank" rel="noopener nofollow">https://ollama.com/download</a></li>
<li>Once it is installed, open the app or run the following command in the terminal:
<code>ollama serve</code></li>
<li>We need a model to run now, using <code>ollama pull phi3.5</code> we pull a model from the Ollama registry.</li>
<li>Clone the project
<code>git clone https://github.com/Yuvadi29/Ai-Comment-Generator.git</code>
<code>cd commentgenerator</code></li>
<li>Install the necessary dependencies:
<code>npm install</code></li>
<li>Run the project in debug mode using <code>F5</code> or <code>CTRL + SHIFT + D</code>. It will open the Debug Window.</li>
<li>Choose the project you want to go to and then select the line you want to comment.</li>
<li>After selecting press <code>CTRL + SHIFT + P</code> and then choose Generate Comment.</li>
<li>Your comment will be generated.</li>
</ol>
<h2>Following extension guidelines</h2>
<p>Ensure that you’ve read through the extensions guidelines and follow the best practices for creating your extension.</p>
<ul>
<li><a href="https://code.visualstudio.com/api/references/extension-guidelines" target="_blank" rel="noopener nofollow">Extension Guidelines</a></li>
</ul>
<h2>Demo</h2>
<p><img src="https://raw.githubusercontent.com/Yuvadi29/Ai-Comment-Generator/fda6f915656a5d875902afedd6e042b5e6d44aba/demo.gif" alt="Working Demo"></p>
<p><strong>Do Not Forget to ⭐ the Repository if you like it!</strong></p>


The One Techie Squad for all things related to career, placements, skills and a lot more..

Checkout our Youtube Channel:
https://www.youtube.com/@coding_adda

Coding Adda

Learn how to create and run your own AI code comment generator using Ollama and VsCode. This project leverages NodeJs and requires a machine capable of using LLMs. Follow the setup steps to install Ollama, pull a model, clone the project repository, and generate comments for your code files with a simple command.

Create your Own AI Code Commentor and Run it on your machine using Ollama