Skip to content
This repository was archived by the owner on Oct 12, 2022. It is now read-only.

Modified the read me to include installation instructions #14

Open
nmastereal wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Modified the read me to include installation instructions #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# vscode-comment
Adds simple jsdoc comments for the parameters of a selected function signature

## Installation
The extension is available on the vscode extension store. To install via vscode go to View > Extensions > search "Add jsdoc comments" > Install

## Using
In a typescript or javascript file, select a function signature, ideally one that contains one or more parameters. Select the whole function signature then invoke the Add Doc Comments extension (open the command palette (F1 on Windows) and look for the command 'Add doc comments'. Hit enter.)

Expand Down