Skip to content
| Marketplace
Sign in
Visual Studio Code>Other>iBEAM AutoDocNew to Visual Studio Code? Get it now.
iBEAM AutoDoc

iBEAM AutoDoc

Optisol

|
44 installs
| (0) | Free
Automated Documentation Generator using Azure OpenAI
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

AutoDoc Generator

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

  1. Install the extension from the VS Code Marketplace
  2. Ensure Python is installed and accessible in your system PATH
  3. The extension will handle all other dependencies automatically

Usage

Generating Documentation

  1. Open your project in VS Code
  2. Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
  3. Type "Generate Documentation" and select the command
  4. It save documentation in a Documentation folder within your project

Checking Usage Limits

  1. Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
  2. Type "Check Documentation Generation Limit" and select the command
  3. 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

Release Notes

1.0.0

Initial release of AutoDoc Generator

  • AI-powered documentation generation
  • Azure OpenAI integration
  • Workspace-wide processing
  • Structured documentation output

Enjoy automated documentation generation! 🚀

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft