Есть ли уже поддержка XML-документации внутри Tymdercript?

Question

Есть уже поддержка XML-документации внутри Tymdercript?Похоже, нет, но, может быть, я что-то упускаю.

Я бы хотел что-то вроде этого:

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>
    }
}

.

Answer 1

Нет упоминания об этом в языке спецификации, поэтому в настоящее время нет поддержки для этой функции.

Удобное использование синтаксиса комментариев - создать зависимость в исходном файле:

/// <reference path="..."/>

.

Вы можете Предлагайте такие функции, как это на странице проекта - так что его можно добавить на язык в будущем, еслиИдея получает тягу.

Answer 2

Для того, что это стоит, образцы из Microsoft включают в себя этот стиль комментариев.Из образца параллакса:

    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);
        });
    }

.

Answer 3

Видимо JSDOC теперь поддерживается, по крайней мере, в Visual Studio Code, так как в настоящее время я использую его там, и он показывает в всплывающих окнах IntelliSense.