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?
Multi-Line comments in Typescript This can be denoted by using /* */.
TypeScript support By default, Visual Studio 2022 provides language support for JavaScript and TypeScript files to power IntelliSense without any specific project configuration. For compiling TypeScript, Visual Studio gives you the flexibility to choose which version of TypeScript to use on a per-project basis.
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.
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
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With