Code Explainer

This is a VS Code extension that explains every bit of code inside your editor. It uses the OpenAI API to generate explanations for code.

Installation

To install the extension, open VS Code and go to the Extensions tab. Search for Code Explainer and click Install. Alternatively, You can install it from here

WHY YOU SHOULD USE IT?

• You have trouble understanding an open-source project.
• Or Maybe you just copied the code from Stack Overflow or some other site, and you don't understand what you've just written.

HOW TO USE!?

Once the extension is installed, you can use the command Code Explainer: Explain to get an explanation for any piece of code. All you have to do is select the piece of code you want the explanation for and hit Ctrl + shift + p and search for explain.

Configuration

But before that, you have to configure your OpenAI API key. Go to your VSCode settings(Ctrl + ,) and search for code-explainer and set your OPENAI API KEY which you can easily obtain from here - openai

Here is an example of how the extension can be used:

1. Open a file with some code in it.
2. Select the code you want to explain.
3. Click the Code Explainer: Explain command.
4. The extension will generate an explanation for the code and show it in a side panel.

CONTRIBUTING

Feel free to contribute to the Project. Even if it's just raising an issue or fixing a typo, it would matter a lot 💘

I hope you find this extension useful!