Je tam už podpoře XML dokumentace uvnitř strojopisem? Zdá se, že tam není, ale možná jsem s výhledem na něco.
Rád bych něco takového:
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>
}
}
Neexistuje žádná zmínka o to ve specifikaci jazyka, takže v současné době neexistuje podpora pro tuto funkci.
Jediná připomínka syntax v použití je vytvořit závislost na zdrojovém souboru:
/// <reference path="..."/>
Můžete navrhnout funkce, jako je to na stránce projektu - tak, aby mohl být přidán do jazyka v budoucnu v případě, že idea získává trakce.
Za to, co stojí za to, vzorky od společnosti Microsoft se zahrnují tento styl komentář. Z Parallax vzorku:
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);
});
}
Zřejmě JSDoc je nyní podporována alespoň v Visual Studio zákoníku, jak jsem ji v současné době používají tam a je to vidět v Intellisense dav.