C'è già supporto per la documentazione XML all'interno dei dattiloscritti?

Question

C'è già supporto per la documentazione XML all'interno dei dattiloscritti?Sembra che non ci sia, ma forse sto trascurando qualcosa.

Mi piacerebbe qualcosa del genere:

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

Non vi è alcuna menzione nella specifica della lingua, quindi non è attualmente alcun supporto per questa funzione.

L'unico commento Sintassi in uso è quello di creare una dipendenza da un file sorgente:

/// <reference path="..."/>

.

Puoi suggerisci caratteristiche come questa nella pagina del progetto - quindi potrebbe essere aggiunta alla lingua in futuro se ilIdea guadagna trazione.

Answer 2

Per quello che vale, i campioni di Microsoft includono questo stile di commento.Dal campione di Parallax:

    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

Apparentemente JSDOC è ora supportato, almeno nel codice Visual Studio, poiché attualmente lo sto usando lì e mostra nei popup IntelliSense.