Generer dokumentationskommentarer til TypeScript i Visual Studio


Når jeg arbejder i C# ved hjælp af ReSharper + StyleCop, kan jeg automatisk generere grundlæggende dokumentationskommentarer til metoder, som ser nogenlunde sådan ud:

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

som jeg derefter kan tilføje ekstra detaljer til.

Findes der et lignende værktøj til TypeScript, som vil generere JSDoc-kommentarsektionerne, så jeg blot kan udfylde detaljerne?

Svar #1

ReSharper har et efterslæbsitem for dette - Automatiserede JavaScript-kommentarer.

I øjeblikket skal du bare skrive /** og derefter indtaste dem selv.

Der er nogle udvidelser, der opretter vsdoc- og jsdoc-kommentarer*.

*JSDoc tilføjet i v2.

Svar #2

Der er en fin lille udvidelse i VS Code MarketPlace kaldet Document This. Prøv den. Andre muligheder er: Kommentarer i Typescript af S. Albert og DocStubsJs af Michael Obermeyer

Relaterede artikler