JSDoc Generator for VS Code

A Visual Studio Code extension that automatically generates JSDoc comments for your functions or methods. The extension formats the parameters and return values to match the standard JSDoc style, helping you document your code faster and more efficiently.

Features

• Automatically generates JSDoc comments for the selected function or method.
• Supports various parameter types, including string, number, Array, any, and custom types.
• Removes redundant type information and aligns the comment with the function signature.
• Provides the ability to trigger JSDoc generation via:
  • Command Palette
  • Status Bar Button
  • Keybinding (Cmd+Shift+J on macOS, Ctrl+Shift+J on Windows/Linux)

Installation

Prerequisites

Before installing the extension, ensure you have Visual Studio Code installed.

Install from the VS Code Marketplace

1. Open the Command Palette in VS Code (Cmd+Shift+P or Ctrl+Shift+P).
2. Search for Extensions: Install Extensions.
3. In the Extensions view, search for JSDoc Generator and install it.