Van-e már támogatja az XML dokumentáció belső géppel? Úgy tűnik, nincs, de talán én nyílik valamit.
Szeretnék valami ilyesmit:
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>
}
}
Nincs említés ezen a nyelven leírás, így jelenleg nem támogatja ezt a funkciót.
Az egyetlen megjegyzés szintaxis használata az, hogy hozzon létre egy függőség a forrás file:
/// <reference path="..."/>
Akkor javasoljuk, funkciók, mint például ez a projekt oldalán - így lehetne egészíteni a nyelvet a jövőben, ha az ötlet nyereség tapadást.
Mert mit ér, a mintákat a Microsoft nem tartalmazzák ezt a stílust a megjegyzést. A Parallax minta:
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);
});
}
Úgy tűnik JSDoc már támogatott, legalább a Visual Studio-kód, mivel én jelenleg használó ott, és ez azt mutatja, az IntelliSense popup.