Skip to content
| Marketplace
Sign in
Visual Studio Code>Programming Languages>PyDoc IntelliSenseNew to Visual Studio Code? Get it now.
PyDoc IntelliSense

PyDoc IntelliSense

Marz Technologies

|
10 installs
| (0) | Free
JSDoc-style documentation for Python with IntelliSense integration
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

PyDoc IntelliSense

A Visual Studio Code extension that brings JSDoc-style documentation to Python with rich IntelliSense integration.

Features

  • Write structured documentation for Python functions and methods using JSDoc-style syntax
  • Get rich IntelliSense suggestions with parameter types and descriptions
  • View comprehensive documentation when hovering over functions
  • Support for function parameters, return types, examples, and more

Example Usage

def calculate_area(radius, height=None):
    """Calculate the area of a circle or cylinder.
    
    @param {float} radius The radius of the circle or cylinder
    @param {float|None} height Optional height for cylinder calculation
    @returns {float} The calculated area
    
    @example
    # Calculate circle area
    area = calculate_area(5)
    print(area)  # 78.54
    
    @example
    # Calculate cylinder surface area
    area = calculate_area(3, 10)
    print(area)  # 245.04
    
    @since 1.2.0
    """
    import math
    if height is None:
        # Circle area
        return math.pi * radius ** 2
    else:
        # Cylinder surface area
        return 2 * math.pi * radius * (radius + height)

Installation

  1. Open VS Code
  2. Go to Extensions (Ctrl+Shift+X)
  3. Search for "PyDoc IntelliSense"
  4. Click Install

Configuration

This extension contributes the following settings:

  • pydocIntelliSense.enable: Enable/disable the extension
  • pydocIntelliSense.docstringFormat: Format of docstrings to parse (triple quotes or hash comments)

Release Notes

0.1.0

  • Initial release
  • Support for JSDoc-style tags in Python docstrings
  • IntelliSense integration for function/method documentation
  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft