Function Comment Generator

This is a VS Code extension that generates comments for functions in Flutter code using OpenAI's GPT-3 model. The comments are generated based on the function signature and body.

Prerequisites

To use this extension, you'll need to have an OpenAI API key. If you don't have one already, you can sign up for an account and get an API key from the OpenAI website.

Usage

To generate comments for functions in a Flutter code file, open the file in VS Code and press Ctrl+Shift+P (Windows) or Cmd+Shift+P (Mac) to open the Command Palette. Type "Comments Generator" and select the command or you can use the shortcut keys: Ctrl+alt+c (Windows) or Cmd+alt+c (Mac). To remove comments type "Comments Remover" and select the command or you can use the shortcut keys: Ctrl+alt+r (Windows) or Cmd+alt+r (Mac).

The extension will analyze the file and generate comments for each function in the file using the OpenAI API. The comments will be added as a single-line comment above each function.

Note that the extension currently only supports Flutter code.

Release Notes

1.0.0

Added comments remover and updated the code to accept more variety of functions

1.0.1

Added better prompt for the comments to be generated

Credits

This extension was created by Mompi Devi and uses the gpt-3.5-turbo model to generate comments.

License

This extension is licensed under the MIT License. See the LICENSE file for details.