it-swarm.com.de

Wo ist die Syntax für TypeScript-Kommentare dokumentiert?

Ist die Syntax für TypeScript-Kommentare irgendwo dokumentiert?

Und unterstützt es jetzt zufällig das C # /// System?

128
David Thielen

Die richtige Syntax wird jetzt von TSDoc verwendet. Damit können Sie Ihre Kommentare von Visual Studio Code oder anderen Dokumentationstools verstehen lassen.

Ein guter Überblick über die Syntax ist verfügbar hier und besonders hier . Die genaue Spezifikation sollte "bald" geschrieben werden .

Eine weitere Datei, die es wert ist, ausgecheckt zu werden, ist diese , wo Sie nützliche Standard-Tags sehen.

Hinweis : Sie sollten JSDoc nicht verwenden, wie auf der TSDoc-Hauptseite erläutert: Warum kann JSDoc nicht der Standard sein? Leider wird die JSDoc-Grammatik nicht streng spezifiziert, sondern aus dem Verhalten einer bestimmten Implementierung abgeleitet. Die Mehrheit der Standard-JSDoc-Tags beschäftigt sich mit der Bereitstellung von Typanmerkungen für einfaches JavaScript, was für stark typisierte Sprachen wie TypeScript irrelevant ist. TSDoc behebt diese Einschränkungen und geht gleichzeitig komplexere Ziele an.

34
Mic

TypeScript verwendet JSDoc. z.B.

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

So lernen Sie jsdoc: https://jsdoc.app/

Demo

Sie müssen die Typanmerkungserweiterungen jedoch nicht in JSDoc verwenden.

Sie können (und sollten) weiterhin andere jsdoc -Block-Tags wie @returns Usw. verwenden.

Beispiel

Nur ein Beispiel. Konzentrieren Sie sich auf die Typen (nicht auf den Inhalt).

JSDoc-Version (Benachrichtigungstypen in Dokumenten):

/**
 * Returns the sum of a and b
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function sum(a, b) {
    return a + b;
}

TypeScript-Version (beachten Sie die neue Position der Typen):

/**
 * Takes two numbers and returns their sum
 * @param a first input to sum
 * @param b second input to sum
 * @returns sum of a and b
 */
function sum(a: number, b: number): number {
    return a + b;
}
154
basarat

Sie können auch Informationen zu Parametern, Rückgaben usw. hinzufügen, indem Sie Folgendes verwenden:

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

Dies führt dazu, dass Editoren wie VS Code Folgendes anzeigen:

enter image description here

53
Sharpiro

Sie können Kommentare wie in regulärem JavaScript verwenden:

Die TypeScript-Syntax ist eine Obermenge der Ecmascript 5 (ES5) -Syntax. [...]

Dieses Dokument beschreibt die von TypeScript hinzugefügte syntaktische Grammatik

Davon abgesehen habe ich dies nur bei Kommentaren in den Sprachspezifikationen gefunden:

TypeScript bietet JavaScript-Programmierern außerdem ein System mit optionalen Typanmerkungen . Diese Typanmerkungen ähneln den JSDoc-Kommentaren im Closure-System, sind jedoch in TypeScript direkt in die Sprachsyntax integriert. Diese Integration verbessert die Lesbarkeit des Codes und reduziert die Wartungskosten für die Synchronisierung von Typanmerkungen mit den entsprechenden Variablen.

11.1.1 Abhängigkeiten von Quelldateien:

Ein Kommentar des Formulars /// <reference path="..."/> fügt eine Abhängigkeit von der im Pfadargument angegebenen Quelldatei hinzu. Der Pfad wird relativ zum Verzeichnis der enthaltenen Quelldatei aufgelöst

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

14
CoDEmanX

TypeScript ist daher eine strikte syntaktische Obermenge von JavaScript

  • Einzeilige Kommentare beginnen mit //
  • Mehrzeilige Kommentare beginnen mit/* und enden mit * /
4
Ayushi Jain