2012-10-02 24 views
5

Esiste già il supporto per la documentazione XML in TypeScript? Sembra che non ci sia, ma forse sto trascurando qualcosa.Esiste già il supporto per la documentazione XML in TypeScript?

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> 
    } 
} 

risposta

5

Non v'è alcuna menzione di questo nella specifica del linguaggio, per cui non esiste attualmente alcun supporto per questa funzionalità.

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

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

È possibile suggest features such as this on the project page - così si potrebbe aggiungere al linguaggio in futuro, se la trazione idea guadagni.

+0

Grazie, aggiunta la richiesta di funzionalità. –

+1

C'è un collegamento alla richiesta di funzionalità? Mi piacerebbe sostenerlo. – Amr

+0

Qui ho postato il commento: typescript.codeplex.com/discussions/397660 Anders Hejlsberg ha scritto che stavano mirando a JSDoc forse invece di Xml Documentation. –

0

Per quello che vale, esempi da Microsoft includono questo stile 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); 
     }); 
    } 
+0

Ho aggiunto un commento su codeplex e la risposta di Anders Hejlsberg era che si stavano appoggiando a JsDoc. http://typescript.codeplex.com/discussions/397660 –

-1

Apparentemente JSDoc è ora supportato, almeno in codice Visual Studio, come Attualmente sto usando lì e si vede nei popup IntelliSense.