CodeNexAI - AI-Powered Code Documentation

Overview

CodeNexAI is a VS Code extension that helps you generate high-quality documentation for your code using the power of AI. It simplifies the process of documenting your code, making it easier to understand, maintain, and collaborate on projects.

Features

• Supported Languages:

• AI-Powered Documentation: Automatically generate documentation for selected code snippets.

• Easy to Use: Simply select the code, right-click, and choose "CodenexAI: Generate Documentation for Selection".

• Context Menu Integration: Seamlessly integrated into the VS Code editor via the context menu.

• Supports Multiple Languages: Works with a wide range of programming languages.

• Improved Code Understanding: Helps you and your team understand code faster and more effectively.

• Enhanced Collaboration: Facilitates better collaboration by providing clear and concise documentation.

Installation

1. Open Visual Studio Code.
2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X).
3. Search for "CodeNexAI".
4. Click "Install".

Usage

1. Sign Up and Verify Your Email

To use the extension, you need to sign up for an account at codenexai.com and verify your email address. This step is crucial for accessing the AI-powered documentation generation service.

Login

To login, use the command CodeNexAI: Login in the command palette (Ctrl+Shift+P or Cmd+Shift+P)

Logout

To logout, use the command CodeNexAI: Logout in the command palette (Ctrl+Shift+P or Cmd+Shift+P)

2. Select Code

Open a code file in the editor and select the code snippet you want to document.

3. Generate Documentation

Right-click on the selected code and choose "CodeNexAI: Generate Documentation for Selection" from the context menu.

4. Review and Refine

The generated documentation will appear in a separate panel. Review the documentation and refine it as needed to ensure accuracy and clarity.

Example

Let's say you have the following JavaScript function:

function add(a, b) {
  return a + b;
}

1. Select the code snippet.
2. Right-click and select "CodeNexAI: Generate Documentation for Selection".
3. CodeNexAI will generate documentation similar to this:

/**
 * Adds two numbers together.
 *
 * @param {number} a The first number.
 * @param {number} b The second number.
 * @returns {number} The sum of the two numbers.
 */
function add(a, b) {
  return a + b;
}

Release Notes

0.1.3

• Added option for logout

Contributors

• @Vishakha Singhal
• @Swadesh Kumar

Enjoy using CodeNexAI!