Er det allerede støtte for XML Dokumentasjon inne Loggfila? Det virker som om det ikke er det, men kanskje jeg utsikt noe.
Jeg vil gjerne ha noe som dette:
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>
}
}
Det er ingen omtale av dette i språkspesifikasjonen, så det er ikke noe støtte for denne funksjonen.
Bare en kommentar syntaks i bruk er å skape en avhengighet av en kildefil:
/// <reference path="..."/>
Du kan foreslå funksjoner som dette på prosjektsiden - slik at det kunne bli lagt til språket i fremtiden hvis ideen gevinster trekkraft.
For hva det er verdt, vet prøver fra Microsoft inkludere denne stilen kommentar. Fra Parallax prøve:
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);
});
}
Tilsynelatende JSDoc støttes nå, i hvert fall i Visual Studio-koden, som jeg for øyeblikket bruker det der og det viser i INTELLISENSE popups.