Docify AI - Docstring & comment writer

Analyzes selected code blocks using language-specific AST parsing and semantic understanding to automatically generate contextually appropriate docstrings in JSDoc, Javadoc, Python docstring, or language-native formats. The extension integrates with VS Code's text selection API to capture code context, sends it to an LLM backend for generation, and inserts formatted documentation directly above function/class definitions while preserving indentation and style conventions.

Detects inline comments and docstrings in source code, preserves code syntax and variable names during translation, and replaces comments with translations in target languages while maintaining proper comment syntax for the detected language. Uses language-specific comment delimiters (// for C-style, # for Python, -- for Lua) to avoid breaking code structure, and applies semantic understanding to avoid translating code identifiers or technical terms that should remain unchanged.

Automatically detects the programming language of the current file using VS Code's language mode API and file extension, then applies the appropriate docstring format (JSDoc for JavaScript, Javadoc for Java, Google-style for Python, etc.) when generating documentation. Inserts generated docstrings at the correct indentation level and position (immediately above function/class definition) using VS Code's TextEdit API, preserving existing code formatting and style.

Parses function signatures using language-specific regex or lightweight AST parsing to extract parameter names, types (if available), and return types, then uses this structured data to generate parameter-specific documentation in the docstring. For typed languages (TypeScript, Java, Python with type hints), extracts type information directly; for untyped languages, infers parameter purpose from variable names and usage patterns within the function body.

Provides a command to generate docstrings for multiple functions/classes in a file or directory, queuing API requests and displaying progress in VS Code's status bar or notification UI. Implements rate-limiting to respect API quotas, batches requests where possible to reduce API calls, and allows users to review and accept/reject generated docstrings before insertion, with rollback capability for rejected changes.

Registers custom commands in VS Code's command palette (e.g., 'Docify: Generate Docstring', 'Docify: Translate Comments') and binds them to configurable keyboard shortcuts. Integrates with VS Code's text selection API to capture the current selection, executes the command via the extension API, and inserts results directly into the editor using TextEdit operations that respect undo/redo history.

Tracks API calls made by the extension (docstring generations, translations) and displays usage statistics in VS Code's status bar or settings UI. Implements quota limits for free tier users (e.g., 10 docstrings/month) and enforces rate limiting by queuing requests and rejecting calls that exceed limits. Provides upgrade prompts when users approach quota limits, with links to pricing/subscription pages.

Maintains a language registry mapping file extensions to language identifiers, docstring formats, comment syntax, and type annotation styles. When generating docstrings, looks up the target language in the registry and applies language-specific templates and conventions (e.g., JSDoc for JavaScript, Javadoc for Java, Google-style for Python). Supports both compiled languages (C++, Java, Go) and interpreted languages (Python, JavaScript, Ruby) with appropriate documentation standards for each.