2012-10-02 24 views
5

Czy istnieje już wsparcie dla dokumentacji XML w TypeScript? Wygląda na to, że tak nie jest, ale może coś przeoczyłem.Czy istnieje już wsparcie dla dokumentacji XML w TypeScript?

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

Odpowiedz

5

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 suggest features such as this on the project page - tak to można dodać do języka w przyszłości, jeśli trakcji zyski pomysł.

+0

Dzięki, dodano żądanie funkcji. –

+1

Czy istnieje link do żądania funkcji? Chciałbym to poprzeć. – Amr

+0

Tutaj napisałem komentarz: typescript.codeplex.com/discussions/397660 Anders Hejlsberg napisał, że celowali w JSDoc zamiast w Xml Documentation. –

0

Za to, co jest warte, próbki od Microsoft zawierają ten styl komentarza. 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); 
     }); 
    } 
+0

Dodałem komentarz dotyczący codeplex, a odpowiedź Andersa Hejlsberga polegała na tym, że pochylali się w kierunku JsDoc. http://typescript.codeplex.com/discussions/397660 –

-1

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.