AI Docs & Comments
AI Docs & Comments is a Visual Studio Code extension that creates documentation and adds comments to your functions using Artificial Intelligence. This extension connects directly to OpenAI, operating without the intervention of any third-party servers. This unique feature ensures a more cost-effective solution and guarantees the utmost data security and privacy.
As of version 0.0.4 you have the power to tailor the prompts used for generating documentation and adding comments. This means you can guide the AI in a way that best suits your coding style and documentation standards.
Please note that the OpenAI API charges approximately $1 for generating over 60 documentations.
How to Use
Before starting, ensure you've correctly adjusted your settings. You can do this by executing ⌘+⇧+P on Mac or Ctrl+Shift+P on Windows and selecting
To generate documentation, follow these steps:
For adding comments, follow these steps:
This extension contributes the following settings:
Everyone is welcome to contribute to this project! If you have improvement suggestions, feature requests, or want to improve our code or documentation, we appreciate your help.
Here's how you can contribute:
We're looking forward to seeing your pull requests!
This extension is licensed under the MIT License.