Pergunta

Já lá está o suporte para XML Documentação dentro do TypeScript?Parece que não existe, mas talvez eu esteja com vista sobre algo.

Eu gostaria de algo como isto:

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>
    }
}
Foi útil?

Solução

Não há nenhuma menção a isso na especificação de linguagem, portanto, atualmente, não há suporte para esse recurso.

O único comentário de sintaxe em uso é criar uma dependência em um arquivo de origem:

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

Você pode sugerir recursos como este na página do projeto - então, ele pode ser adicionado para a língua no futuro, se a ideia ganha força.

Outras dicas

Por que vale a pena, a partir de amostras Microsoft não incluir este tipo de comentário.A partir da Paralaxe exemplo:

    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 JSDoc é agora suportada, pelo menos em Código do Visual Studio, como eu estou usando atualmente, ele lá e mostra o intellisense pop-ups.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top