The Ensias AI Doc Gen extension helps developers generate inline documentation for their code using AI-powered tools. It supports both local and remote providers for generating comments and documentation.
Features
Generate Inline Documentation: Automatically generate comments for functions in your code.
Support for Multiple Languages: Includes parsers for Java and TypeScript.
Local and Remote Providers: Choose between local LLM servers or remote providers like OpenAI and Gemini.
Customizable Settings: Configure API keys, models, and server details.
Installation
Clone the repository or download the extension.
Open the folder in Visual Studio Code.
Press F5 to launch the extension in a new VS Code window.
Usage
Commands
Set API Key:
Open the command palette (Ctrl+Shift+P).
Select Ensias AI Doc Gen: Set API Key.
Enter your API key for OpenAI or Gemini.
Generate Inline Documentation:
Open a file in the editor.
Press Ctrl+Alt+G to generate comments for functions in the file.
Generate Documentation:
Open a file in the editor.
Press Ctrl+Alt+F to generate documentation using the configured generator.
Settings
You can configure the extension in the VS Code settings menu:
Provider (ensiasAI.provider):
Choose between local or remote.
Remote Provider (ensiasAI.remoteProvider):
Select openai or gemini.
API Key (ensiasAI.apiKey):
Enter your API key for the remote provider.
Model (ensiasAI.model):
Specify the model to use (leave empty for default).
Local Server URL (ensiasAI.URL):
Set the URL for the local LLM server.
Local Server Port (ensiasAI.port):
Set the port for the local LLM server.
Known Issues
Ensure the workspace folder is properly set up for the extension to function.
The gradle javadoc command requires a Gradle-based project.
Contributing
Feel free to contribute by submitting issues or pull requests to the repository.
