https://github.com/franciscoossian/docfy-ai

Generate contextually accurate documentation comments for most widely used programming languages, following community standards, powered by GPT.
https://github.com/franciscoossian/docfy-ai

Last synced: 9 days ago
JSON representation

Generate contextually accurate documentation comments for most widely used programming languages, following community standards, powered by GPT.

• Host: GitHub
• URL: https://github.com/franciscoossian/docfy-ai
• Owner: FranciscoOssian
• License: mit
• Created: 2023-05-20T21:57:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-21T15:24:39.000Z (over 1 year ago)
• Last Synced: 2024-11-17T03:42:11.744Z (2 months ago)
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=FranciscoOssian.docfy-ai
• Size: 43.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DocFy-AI

DocFy-AI is a VSCode extension that utilizes GPT-based AI to automatically generate comprehensive documentation for code files and projects. It supports multiple programming languages and provides customizable documentation templates. With its intuitive user interface, documenting code has never been easier.

## Features

- Automatic code documentation generation using GPT-based AI.

- Generate detailed documentation for code files and projects.

- Supports multiple programming languages.

- Customizable documentation templates.

- Intuitive user interface for easy interaction.

## Requirements

To use the DocFy-AI extension, you need an OpenAI APIKey. This document generator leverages GPT to provide accurate and helpful documentation.

## Extension Settings

This extension contributes the following settings:

- `extension.apiKey`: OpenAI API Key

- `extension.JSDocPatern`: JavaScript documentation pattern

- `extension.PyDocPatern`: Python documentation pattern

- `extension.JavaDocPatern`: Java documentation pattern

- `extension.CSharpDocPatern`: C# documentation pattern

- `extension.PHPDocPatern`: PHP documentation pattern

- `extension.RubyDocPatern`: Ruby documentation pattern

- `extension.SwiftDocPatern`: Swift documentation pattern

- `extension.GoDocPatern`: Go documentation pattern

- `extension.KotlinDocPatern`: Kotlin documentation pattern

- `extension.CandCPPDocPatern`: C and C++ documentation pattern

- More settings will be added in the future.

## Usage

1. Open a code file in VSCode.

2. Select the code you want to document or place the cursor in the desired location.

3. Right-click on the selected code or use the context menu.

4. Choose the `Generate Doc` option.

5. The extension will automatically generate documentation based on the selected code and the configured documentation patterns.

Please make sure to configure your OpenAI APIKey in the extension settings before using DocFy-AI.

We wish you success in using the DocFy-AI VSCode extension for generating code documentation effortlessly!