Gibt es Unterstützung bereits für XML-Dokumentation innerhalb Typoskript? Es scheint, gibt es nicht, aber vielleicht etwas, was ich bin mit Blick auf.
Ich würde so etwas wie dies mag:
export class Point {
/// <summary>This is a Point class.</summary>
constructor (public x: number, public y: number) {
/// <summary>Creates a new Point object</summary>
/// <param name=x></param>
/// <param name=y></param>
}
}
Es wird nicht erwähnt dies in der Sprachspezifikation, so gibt es derzeit keine Unterstützung für diese Funktion.
Die einzige Kommentar Syntax verwendet wird eine Abhängigkeit von einer Quelldatei zu erstellen:
/// <reference path="..."/>
Sie können Funktionen wie dies auf der Projektseite vorschlagen - so ist es auf die Sprache in der Zukunft , wenn die Idee gewinnt Traktion hinzugefügt werden könnte.
Für das, was es wert ist, Proben von Microsoft beinhalten diese Art von Kommentar. Von dem Parallax Beispiel:
constructor(scrollableContent: HTMLElement, perspective: number) {
/// <param name="scrollableContent">The container that will be parallaxed.</param>
/// <param name="perspective">The ratio of how much back content should be
/// scrolled relative to forward content. For example, if this value is
/// 0.5, and there are 2 surfaces, the front-most surface would be scrolled
/// normally, and the surface behind it would be scrolled half as much.</param>
this.perspective = perspective;
this.surface = [];
this.content = scrollableContent;
$(scrollableContent).scroll((event: JQueryEventObject) => {
this.onContainerScroll(event);
});
}
Offenbar ist JSDoc jetzt, zumindest in Visual Studio-Code unterstützt, da ich zur Zeit dort bin mit, und es zeigt in den intellisense Popups.