Generate documentation comments for typescript in Visual Studio

Question

When working in C# using ReSharper + StyleCop I can auto generate basic documentation comments for methods, which looks something like:

    /// <summary>
    /// The login.
    /// </summary>
    /// <param name="returnUrl">
    /// The return Url.
    /// </param>
    /// <returns>
    /// The <see cref="Task"/>.
    /// </returns>

which I can then add extra detail into.

Is there a similar tool for TypeScipt which will generate the JSDoc comment sections so I can simply fill in the details?

Fenton · Accepted Answer · 2015-01-16 14:55:11Z

6

ReSharper has a backlog item for this - Automated JavaScript Comments.

At the moment, you just have to type /** and then enter them yourself.

There are some extension that create vsdoc and jsdoc comments*.

*JSDoc added in v2.

edited Jan 16, 2015 at 14:55

answered Nov 13, 2014 at 10:00

Fenton

253k74 gold badges404 silver badges414 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

JWP Over a year ago

Interesting and I wonder how long would it take MSFT to do this? 5 minutes?

Wet Noodles Over a year ago

The vsdoc extension mentioned in this answer has been updated to support both JSDoc and TypeScript!

Anish Reddy · Accepted Answer · 2019-04-08 07:40:50Z

2

There's a nice little extension in the VS Code MarketPlace called Document This. Try that. Other options are : Comments in Typescript by S.Albert and DocStubsJs by Michael Obermeyer

answered Apr 8, 2019 at 7:40

Anish Reddy

212 bronze badges

Collectives™ on Stack Overflow

Generate documentation comments for typescript in Visual Studio

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related