JSDoc (TypeScript)

[jaandrle]

• [ ] TypeScript: Documentation - JSDoc Reference
• Generate docs from TypeScript with gulp (→jsdoc-to-md)
• [ ] jsdoc-advanced-types-plugin/index.js at master · alshakh/jsdoc-advanced-types-plugin
• [ ] jumpinjackie/jsdoc-typescript-plugin: Experimental JSDoc plugin to generate TypeScript definition files (.d.ts) from JSDoc-annotated source
• [ ] One Reason not to migrate JavaScript to TypeScript | Nerd For Tech

[jaandrle]

Používání JSDoc v TypeScriptu

V tomto příspěvku se zaměříme na koexistenci JavaScriptu s JSDoc a TypeScriptu. Dále na možnosti generování dokumentace z TypeScriptu pomocí gulp.

JSDoc v TypeScriptu

Podpora JSDoc v TypeScriptu umožňuje dokumentovat kód za použití standardních JSDoc anotací. Více informací o podporovaných typech a syntaxi lze nalézt v TypeScript: Documentation - JSDocReference.

Generování dokumentace z TypeScriptu

Můžete použít gulp spolu s jsdoc-to-md pro generování dokumentace z TypeScriptu. Následující Gist poskytuje příklad, jak toho dosáhnout.

Rozšíření JSDoc pro TypeScript

Existují různá rozšíření JSDoc pro lepší podporu TypeScriptu, jako například jsdoc-advanced-types-plugin a jsdoc-typescript-plugin, které umožňují generování TypeScript definic (.d.ts) z JSDoc anotovaného zdrojového kódu.

Důvody pro ne-migraci JavaScriptu na TypeScript

I přesto, že TypeScript nabízí mnoho výhod oproti klasickému JavaScriptu, existují i důvody proč některé projekty raději zůstávají u JavaScriptu. Článek One Reason not to migrate JavaScript to TypeScript | Nerd For Tech se zabývá některými z těchto důvodů.