AutoDoc Generator is a VS Code extension that automatically generates comprehensive documentation for your codebase using Azure OpenAI. It analyzes your code files and creates detailed markdown documentation with intelligent insights about your code structure, methods, and implementation details.
Features
🤖 AI-Powered Documentation: Leverages Azure OpenAI to generate intelligent and context-aware documentation
📁 Bulk Processing: Processes all files in your workspace while respecting .gitignore rules
🎯 Structured Output: Generates well-organized documentation with consistent sections:
File Overview
Content Analysis
Method Explanations
Usage Guidelines
Best Practices
⚡ Progress Tracking: Real-time progress updates during documentation generation
🔒 Secure: Uses VS Code's secure storage for API credentials
📊 Usage Limits: Daily file processing limits with automatic reset
📈 Usage Tracking: Check your daily usage and remaining quota
Requirements
Visual Studio Code 1.74.0 or higher
Python 3.x (Windows/Ubuntu)
Installation
Install the extension from the VS Code Marketplace
Ensure Python is installed and accessible in your system PATH
The extension will handle all other dependencies automatically
Usage
Generating Documentation
Open your project in VS Code
Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
Type "Generate Documentation" and select the command
It save documentation in a Documentation folder within your project
Checking Usage Limits
Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
Type "Check Documentation Generation Limit" and select the command
You'll see a notification showing:
Today's usage count
Remaining files for today
Time until limit reset
Daily Limits
Each user has a daily limit of 50 files
Limits reset at midnight in your local timezone
Supported File Types
The extension can process any text-based source code files, including but not limited to:
Python (.py)
JavaScript/TypeScript (.js, .ts)
Java (.java)
C/C++ (.c, .cpp, .h)
And more...
Known Issues
Large files may take longer to process
Some specialized code constructs might need manual documentation review
