QuickComment for VSCode

Welcome to the QuickComment extension for Visual Studio Code!

This extension leverages the power of OpenAI to help you generate comments for your code files.

With QuickComment, you can easily add informative comments to the entire file with just one click!

Features

The extension introduces the QuickComment: comment file option.
The user will be provided with the commented file, and a UI that displays the changes and allows you to easily merge the desired comments.

• Open workspace
• Open a file in the editor
• Press F1 or ctrl+shift+p and type QuickComment: comment file
• Enter your OpenAI Api Key (you can change this in the settings)
• Your active file will now be commented!
  
  
  

Extension Settings

• QuickComment.apiKey: Set to your OpenAI Api Key

Known Issues

Our extension currently has an issue where it fails to handle large code files for most programming languages, with the exception of Python. This can cause the extension to crash when processing large files.

We are actively working on resolving this issue, but in the meantime, we recommend splitting up large code files into smaller chunks before processing them with our extension.

We apologize for any inconvenience this may cause and appreciate your patience as we work to resolve this issue.

Release Notes

1.0.0

Initial release of QuickComment