Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.77 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.77 KB
Raw

Code Docs AI - Generate Python Code Comments with GPT-4

Application icon

Code Docs AI is a Visual Studio Code extension that leverages the power of GPT-4 to generate code comments for your Python code. It helps you understand your code better by providing insightful and contextually accurate comments.

Features

  • Automatic Comment Generation: Simply highlight the code block you want comments for, right-click and select 'Generate Comment with Code Docs AI'. Code Docs AI will analyze your code and generate a comment that helps explaining what the code does.

  • GPT-4 Powered: Code Docs AI uses the GPT-4 model from OpenAI, which is known for its ability to understand context and generate human-like text. This ensures that the comments generated are accurate and helpful.

  • Python Support: Currently, Code Docs AI supports Python code. We are working on adding support for more languages.

Installation

  1. Open Visual Studio Code
  2. Go to Extensions
  3. Search for 'Code Docs AI'
  4. Click on 'Install'
  5. Open the Code Docs AI settings, either by (1) clicking the wheel symbol next to the 'Uninstall' button, or (2) opening the Visual Studio Code settings and going to the 'Code Docs AI' section under 'Extension'.
  6. Enter your OpenAI API key applicable for GPT-4. This key will be stored on your local machine only.

Usage

  1. Open a Python file in Visual Studio Code
  2. Highlight the code block you want comments for
  3. Right-click and select 'Generate Comments with Code Docs AI'
  4. The comments will be generated and added above the code block

Contributing

We welcome contributions! Please see our contributing guidelines for more details.

License

Code Docs AI is licensed under the MIT License.