Pregunta

¿Ya es compatible con la documentación XML dentro de TypeScript?Parece que no hay, pero tal vez estoy pasando por alto algo.

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

¿Fue útil?

Solución

No hay mención de esto en la especificación del idioma, por lo que actualmente no hay soporte para esta función.

La única sintaxis de comentarios en uso es crear una dependencia en un archivo fuente:

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

Puede Sugerir características como esta en la página del proyecto , por lo que podría agregarse al idioma en el futuro si elidea gana la tracción.

Otros consejos

Por lo que vale la pena, las muestras de Microsoft 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);
        });
    }

Aparentemente se admite JSDOC, al menos en el código de estudio visual, ya que actualmente lo estoy usando allí y se muestra en las ventanas emergentes de Intellisense.

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top