26-1 Documentation JSDoc

Pour documenter les classes et les fonctions, nous utiliserons le standard JSDoc (https://jsdoc.app/about-getting-started.html)

JSDoc permet entre autres de générer un site de documentation, de façon automatisée, puisque les commentaires sont écrits de façon standardisée.

Pour bien utiliser JSDoc avec TypeScript, et donc de pouvoir préciser les types dans les commentaires, on doit activer une option dans WebStorm.

Activer Include types in JSDOc dans WebStorm

Sous les paramètres de WebStorm -> Editor -> Code Style -> TypeScript -> Code Generation, assurez-vous que Include types in JSDoc soit activé.