C'è già il supporto per documentazione XML all'interno tipografico? Sembra che non ci sia, ma forse mi sto sottovalutando qualcosa.
Mi piacerebbe qualcosa di simile:
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>
}
}
Non v'è alcuna menzione di questo nella specifica del linguaggio, per cui non esiste attualmente alcun supporto per questa funzionalità.
L'unico commento di sintassi in uso è quello di creare una dipendenza da un file di origine:
/// <reference path="..."/>
È possibile suggerire le caratteristiche di questo tipo sulla pagina del progetto - in modo che possa essere aggiunto alla lingua in futuro, se la trazione idea guadagni.
Per quel che vale, campioni provenienti da Microsoft non includono questo tipo di commento. Dal campione 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);
});
}
A quanto pare JSDoc è ora supportato, almeno in codice Visual Studio, come Attualmente sto usando esso c'è e si vede nei popup IntelliSense.