CodeDocs AI — Auto Documentation Generator

Generate and maintain accurate documentation for your codebase with AI. Select code, run a command, get perfect docs.

Features

📝 Document Functions

Select any function and generate complete documentation — parameters, return types, examples, and exceptions.

How: Select code → Right-click → "CodeDocs AI: Document This Function" (or Command Palette)

📄 Document Entire Files

Generate file-level headers and inline documentation for all exports in one shot.

How: Open file → Command Palette → "CodeDocs AI: Document Entire File"

📖 Generate README

Creates a full README.md from your project files — description, installation, usage, API reference.

How: Command Palette → "CodeDocs AI: Generate README"

Supported Styles

• JSDoc — JavaScript/TypeScript (@param, @returns)
• TSDoc — TypeScript-specific documentation
• NumPy — Python NumPy-style docstrings
• Google — Google-style Python docstrings
• Sphinx — Sphinx/reStructuredText docstrings

Configure your preferred style in settings.

Setup

1. Install the extension
2. Run "CodeDocs AI: Set OpenAI API Key" from the Command Palette
3. Enter your OpenAI API key (stored securely in VS Code's secret storage)
4. Start documenting!

Configuration

BYOK (Bring Your Own Key)

CodeDocs AI uses your own OpenAI API key. Your code never touches our servers — it goes directly from VS Code to the OpenAI API. We never see your code or your key.

Cost: Using gpt-4o-mini, documenting a function costs ~$0.001. A full file costs ~$0.01.

Requirements

• VS Code 1.85.0 or later
• OpenAI API key (get one here)

Privacy

• Your API key is stored in VS Code's encrypted secret storage
• Code is sent directly to OpenAI's API (not through any intermediary)
• No telemetry, no data collection, no analytics
• Privacy Policy

License

MIT