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
Open VS Code
Go to Extensions (Ctrl+Shift+X)
Search for "PyDoc IntelliSense"
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
