Adds simple jsdoc comments for the parameters of a selected function signature
TypeScript
Switch branches/tags
Nothing to show
Clone or download

README.md

vscode-comment

Adds simple jsdoc comments for the parameters of a selected function signature

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.)

install and work

The extension will parse the selected signature and add @param and @return tags for each parameter and any return type in the selected signature, directly above the signature.

Limitations

The extension does not support any other type of jsdoc tags. It only calculates @param and @return

Parameter types are not inferred based on usage. If a type is not specified, empty braces {} are returned.

Other extensions

Document This provides the same functionality but supports many more tags

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.