Υπάρχει ήδη υποστήριξη για 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.