Есть ли уже поддержка XML документации внутри машинопись? Кажется, что нет, но может быть, я с видом что-то.
Я хотел бы что-то вроде этого:
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>
}
}
Там нет никакого упоминания об этом в спецификации языка, так что в настоящее время нет поддержки этой функции.
Комментарий только синтаксис используется, чтобы создать зависимость от исходного файла:
/// <reference path="..."/>
Вы можете предложить такие функции, как это на странице проекта - так можно было бы добавить к языку в будущем , если идея получает тяговые.
Для чего это стоит, образцы от Microsoft действительно включают этот стиль комментариев. Из 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);
});
}
Видимо JSDoc теперь поддерживается, по крайней мере, в Visual Studio кодекса, так как я в настоящее время использовать его там, и это показывает в IntelliSense всплывающие окна.