Is er al ondersteuning voor XML Documentatie binnen typoscript? Het lijkt erop dat er niet, maar misschien ben ik iets over het hoofd.
Ik zou graag iets als dit:
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>
}
}
Er is geen sprake van in de taal specificatie, zodat er op dit moment geen ondersteuning voor deze functie.
De enige opmerking die syntax in gebruik is om een afhankelijkheid van een bron bestand te maken:
/// <reference path="..."/>
U kunt functies suggereren, zoals deze aan het project pagina - dus het om de taal zou kunnen worden toegevoegd in de toekomst als het idee winsten tractie.
Voor wat het waard is, monsters van Microsoft niet bevatten deze stijl van commentaar. Vanaf het Parallax monster:
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);
});
}
Blijkbaar JSDoc wordt nu ondersteund, althans in Visual Studio Code, want ik ben op dit moment daar het gebruik ervan en dat blijkt in de intellisense popups.