Gibt es bereits Unterstützung für XML-Dokumentation in TypeScript?

Question

Gibt es bereits Unterstützung für XML-Dokumentation in TypeScript? Es scheint, dass es nicht ist, aber vielleicht übersehe ich etwas.

würde ich 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> 
    } 
} 

Answer 1

Es gibt keine Erwähnung dieses in der Sprachspezifikation ist, 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 suggest features such as this on the project page - so ist es auf die Sprache in der Zukunft, wenn die Idee gewinnt Traktion hinzugefügt werden könnte.

Answer 2

Für was es wert ist, enthalten Beispiele von Microsoft 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); 
     }); 
    } 

Answer 3

Offenbar ist JSDoc nun unterstützt, zumindest in Visual Studio-Code, wie ich zur Zeit dort bin mit, und es zeigt in den intellisense Popups.