Search code examples
xml-documentationtypescript

Is there already support for XML Documentation inside TypeScript?

Is there already support for XML Documentation inside TypeScript? It seems there isn't, but maybe I am overlooking something.

I'd like something like this:

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

  • There is no mention of this in the language specification, so there is currently no support for this feature.

    The only comment syntax in use is to create a dependency on a source file:

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

    You can suggest features such as this on the project page - so it could be added to the language in the future if the idea gains traction.