Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there a way to generate JSDoc comments in Visual Studio Code

I am currently developing a NodeJS project and found out that there is no built in functionality to create JSDoc comments for functions/methods.

I am aware of the TypeScript definitions that exist but I couldn't really find anything to match what I need.

WebStorm, for example, has some pretty neat JSDoc functionalities. Can one somehow achieve a similar functionality?

like image 787
zerefel Avatar asked Dec 11 '15 09:12

zerefel


People also ask

How do you write comments in JSDoc?

JSDoc comments should generally be placed immediately before the code being documented. Each comment must start with a /** sequence in order to be recognized by the JSDoc parser. Comments beginning with /* , /*** , or more than 3 stars will be ignored.


1 Answers

Visual Studio 1.10 is now able to generate JSDoc comments.

Just type /** above the function

enter image description here

See Also:

  • VS Code Docs > Languages > Javascript > JSDoc Support
  • VS Code February 2017 Release Notes > Auto JSDoc Comments
like image 95
Dominic Avatar answered Sep 23 '22 06:09

Dominic