CODEWITHSUNDEEP
visual-studiotypescript
Antony Jones
Antony Jones

Reputation: 581

Generate documentation comments for typescript in Visual Studio

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?

Upvotes: 7

Views: 8636

Answers (2)

Anish Reddy
Anish Reddy

Reputation: 21

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

Upvotes: 2

Fenton
Fenton

Reputation: 250922

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.

Upvotes: 6

Related Questions