https://github.com/aarnavshah12/autodoc
AI VS code extension to provide developers documentation and organized comments for their projects
https://github.com/aarnavshah12/autodoc
javascript react visual-studio-code
Last synced: 4 months ago
JSON representation
AI VS code extension to provide developers documentation and organized comments for their projects
- Host: GitHub
- URL: https://github.com/aarnavshah12/autodoc
- Owner: aarnavshah12
- License: mit
- Created: 2024-06-08T03:15:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-31T04:35:47.000Z (over 1 year ago)
- Last Synced: 2025-03-31T13:35:28.928Z (10 months ago)
- Topics: javascript, react, visual-studio-code
- Language: JavaScript
- Homepage:
- Size: 10.2 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# AI Code Commenter & Documentation Generator for VS Code
Welcome to the AI Code Commenter & Documentation Generator for Visual Studio Code! This extension leverages advanced AI to automatically generate meaningful comments and comprehensive documentation for your code, enhancing readability and maintainability.
## Features
Automatic Code Commenting: The AI analyzes your code and inserts relevant comments.
Documentation Generation: Create detailed documentation for functions, classes, and modules.
Customizable Settings: Adjust the style and depth of comments and documentation.
IDE Integration: Seamlessly integrates with Visual Studio Code for a smooth user experience.
Support for Multiple Languages: Works with various programming languages including Python, JavaScript, Java, C++, and more.
## Requirements
- Visual Studio Code
- Internet connection (for AI processing)
## Extension Settings
This extension contributes the following settings:
* **CTRl + SHIFT + P** - key bind to open up the selection of settings. Then select the command with the scroll wheel that you need to use.
* **CTRl + SHIFT + V** - key bind to format documentation file into a Github "style"
## Known Issues
If you encounter any issues or have suggestions, please report them on our GitHub Issues page
## Working with Markdown
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets
## For more information
For further information or questions, contact us at **aarnav.shah.12@gmail.com**, **joshipn2018@gmail.com**, **lucas.l.oliva@gmail.com**, **vasudevan.aryan@gmail.com**.
**FAQ**
Q: Does the extension work offline?
A: No, an internet connection is required for AI processing.
Q: Which programming languages are supported?
A: The extension supports Python, JavaScript, Java, C++, and more. See the settings panel for the full list.
Q: How accurate are the comments and documentation generated?
A: The AI aims for high accuracy, but we recommend reviewing and refining the generated output.
**License**
This project is licensed under the MIT License. See the LICENSE file for details.
## Website
bit.ly/Autodoc8
## Youtube Channel
https://www.youtube.com/channel/UC2JPyedcQ_JJY8xA1hnm15Q
**Enjoy!**