Y a-t-il déjà pris en charge la documentation XML Inside Thypscript?

Question

Y a-t-il déjà pris en charge la documentation XML Inside Thypscript?Il semble qu'il n'y soit pas, mais peut-être que je suis sur quelque chose.

J'aimerais quelque chose comme ceci:

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

Answer 1

Il n'y a aucune mention de ceci dans la spécification linguistique, il n'y a donc actuellement aucun support pour cette fonctionnalité.

La seule syntaxe de commentaire utilisée consiste à créer une dépendance sur un fichier source:

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

vous pouvez suggérer des fonctionnalités telles que celles-ci sur la page du projet - afin de pouvoir être ajouté à la langue à l'avenir si laidée gagne la traction.

Answer 2

Pour ce que ça vaut la peine, les échantillons de Microsoft incluent ce style de commentaire.De l'échantillon de parallaxe:

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

Answer 3

Apparemment, JSDOC est maintenant pris en charge, au moins dans le code Visual Studio, comme je l'utilise actuellement là-bas et cela montre dans les popups Intellisse.