Czy istnieje już wsparcie dla XML dokumentacji wewnątrz maszynopis? Wydaje się, że nie jest, ale może jestem widokiem coś.
Chciałbym coś takiego:
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>
}
}
Nie ma wzmianki o tym w opisie języka, więc nie ma obecnie poparcie dla tej funkcji.
Jedyny komentarz składnia używana jest stworzenie uzależnienia od pliku źródłowego:
/// <reference path="..."/>
Można sugerować funkcje, takie jak ten na stronie projektu - tak, aby mogła być dodana do języka w przyszłości, jeśli trakcji zyski pomysł.
Na co warto, próbki od Microsoft zawierają ten styl komentarzu. Z próbki 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);
});
}
Widocznie JSDoc jest teraz obsługiwana, przynajmniej w Visual Studio Code, a obecnie używam go tam i to widać w pop-upów IntelliSense.