Y at-il déjà en charge XML Documentation à l'intérieur tapuscrit? Il semble qu'il n'y ait pas, mais peut-être que je suis sur quelque chose.
Je voudrais 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>
}
}
Il n'y a pas fait mention dans la spécification du langage, donc il n'y a actuellement aucun support pour cette fonctionnalité.
La syntaxe seulement commentaire en cours d'utilisation est de créer une dépendance sur un fichier source:
/// <reference path="..."/>
Vous pouvez proposer des fonctionnalités telles que cela sur la page du projet - il pourrait être ajouté à la langue à l'avenir si l'idée de traction sur les gains.
Pour ce que ça vaut la peine, des échantillons de Microsoft ne comprennent ce style de commentaire. A partir de l'échantillon 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);
});
}
Apparemment JSDoc est maintenant pris en charge, au moins dans le code Visual Studio, comme je l'utilise actuellement là-bas et cela se voit dans les popups IntelliSense.