2012-10-02 23 views
5

¿Ya existe soporte para la documentación XML dentro de TypeScript? Parece que no, pero tal vez estoy pasando por alto algo.¿Ya existe soporte para Documentación XML dentro de TypeScript?

me gustaría algo como esto:

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

Respuesta

5

No hay ninguna mención de esto en la especificación del lenguaje, por lo que actualmente no hay soporte para esta característica.

El único comentario de sintaxis en uso es la creación de una dependencia de un archivo de origen:

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

Puede suggest features such as this on the project page - por lo que se podría añadir a la lengua en el futuro si la idea ganancias de tracción.

+0

Gracias, agregó la solicitud de función. –

+1

¿Hay un enlace a la solicitud de función? Me gustaría apoyarlo. – Amr

+0

Aquí publiqué el comentario: typescript.codeplex.com/discussions/397660 Anders Hejlsberg escribió que estaban buscando JSDoc quizás en lugar de Xml Documentation. –

0

Por si vale la pena, las muestras de Microsoft sí incluyen este estilo de comentario. De la muestra de paralaje:

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

Agregué un comentario sobre codeplex y la respuesta de Anders Hejlsberg fue que se inclinaban hacia JsDoc. http://typescript.codeplex.com/discussions/397660 –

-1

Al parecer jsdoc ahora es compatible, por lo menos en código de Visual Studio, ya que estoy usando actualmente allí y se nota en las ventanas emergentes de IntelliSense.

Cuestiones relacionadas