Où la syntaxe des commentaires TypeScript est-elle documentée?

TypeScript utilise JSDoc. par exemple

 /** This is a description of the foo function. */ function foo() { } 

Pour apprendre jsdoc: http://usejsdoc.org/

Mais vous n’avez pas besoin d’utiliser les extensions d’annotation de type dans JSDoc.

Vous pouvez également append des informations sur les parameters, les retours, etc. en utilisant:

 /** * This is the foo function * @param bar This is the bar parameter * @returns returns a ssortingng version of bar */ function foo(bar: number): ssortingng { return bar.toSsortingng() } 

Cela obligera les éditeurs comme VS Code à l’afficher comme suit:

Vous pouvez utiliser des commentaires comme en JavaScript:

La syntaxe TypeScript est un sur-ensemble de la syntaxe Ecmascript 5 (ES5). […]

Ce document décrit la grammaire syntaxique ajoutée par TypeScript

En dehors de cela, je n’ai trouvé que des commentaires dans les spécifications de langue:

TypeScript fournit également aux programmeurs JavaScript un système d’ annotations de type facultatif. Ces annotations de type sont comme les commentaires JSDoc du système de fermeture, mais dans TypeScript, elles sont directement intégrées à la syntaxe du langage. Cette intégration rend le code plus lisible et réduit le coût de maintenance de la synchronisation des annotations de type avec les variables correspondantes.

11.1.1 Dépendances des fichiers sources:

Un commentaire du formulaire /// ajoute une dépendance au fichier source spécifié dans l’argument path. Le chemin est résolu par rapport au répertoire du fichier source contenant

La source:
https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md

TypeScript est un sur-ensemble syntaxique ssortingct de JavaScript.

• Les commentaires sur une seule ligne commencent par //
• Les commentaires sur plusieurs lignes commencent par / * et se terminent par * /