¿Existe ya el apoyo a la documentación XML dentro mecanografiado? Parece que no es, pero tal vez se me escapa 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>
}
}
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 crear una dependencia de un archivo de origen:
/// <reference path="..."/>
Puede sugerir características como este en la página del proyecto - por lo que se podría añadir a la lengua en el futuro si la idea ganancias de tracción.
Por lo que vale la pena, las muestras de Microsoft no incluyen este tipo 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);
});
}
Al parecer jsdoc es ahora compatible, al menos en código de Visual Studio, ya que estoy usando actualmente allí y se nota en las ventanas emergentes de IntelliSense.