Există deja suport pentru XML Documentație în interiorul typescript? Se pare că nu există, dar poate eu sunt cu vedere ceva.
Aș vrea ceva de genul:
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>
}
}
Nu există nici o mențiune despre acest lucru în caietul de sarcini limba, astfel încât nu există în prezent nici un suport pentru această caracteristică.
Singurul comentariu Sintaxa utilizată este de a crea o dependență de un fișier sursă:
/// <reference path="..."/>
Puteți sugera caracteristici , cum ar fi acest lucru pe pagina proiectului - așa că ar putea fi adăugat în limba în viitor , în cazul în care câștigurile de tracțiune idee.
Pentru ceea ce merită, mostre de la Microsoft includ acest stil de comentariu. Din eșantionul 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);
});
}
Se pare că JSDoc este acum susținută, cel puțin în Visual Studio Code, ca eu sunt o folosesc în prezent acolo și arată în popup IntelliSense.