Commentify

Commentify is a Visual Studio Code extension that automates the process of adding informative and professional comments above your functions using AI-generated content. It enhances code readability, collaboration, and saves valuable development time.

Features

• Automatically adds comments above JavaScript and JavaScript React functions.
• Utilizes the power of ChatGPT to generate informative comments based on the function name and body.
• Improves code documentation and enhances collaboration among developers.
• Works seamlessly with any JavaScript project in Visual Studio Code.

Installation

1. Launch Visual Studio Code.
2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X).
3. Search for "Commentify" in the Marketplace.
4. Click "Install" to install the extension.
5. Reload Visual Studio Code to activate the extension.

Usage

1. Open a JavaScript or JavaScript React file in Visual Studio Code.
2. Ensure the file contains functions that you want to add comments to.
3. Run the "Add Comments Above Functions" command by:
   • Opening the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
   • Searching for "Add Comments Above Functions".
   • Selecting the command from the list or using the specified keybinding.
4. Commentify will automatically add comments above the functions using AI-generated content.

Configuration

Commentify currently doesn't require any additional configuration. It utilizes the default settings to generate comments. However, stay tuned for future updates that may include configurable options.

Troubleshooting

If you encounter any issues or have questions, you can reach out to us by creating an issue in the Commentify GitHub repository.

Contributions

Contributions are welcome! If you would like to contribute to Commentify.

License

This project is licensed under the MIT License.