Zaten var mı typescript içindeki XML Belgeleri için destekliyor? Orada değil gibi görünüyor, ama belki bir şeyler bakan ediyorum.
Böyle bir şey istiyorum:
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>
}
}
dil şartnamede bu hiçbir söz, bu nedenle bu özellik için herhangi bir destek bulunmuyor.
Kullanılan tek yorum sözdizimi, kaynak dosya üzerinde bir bağımlılık oluşturmaktır:
/// <reference path="..."/>
Sen olabilir böyle bir proje sayfasında bu gibi özellikleri önermek gelecekte eğer fikri kazançlar çekiş dilin eklenebilir böylece -.
Ne olursa olsun, Microsoft'tan numuneler yorumun bu tarzı eklerim için. Paralaks numunesinden:
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);
});
}
Görünüşe göre şu anda kullanıyorum olarak JSDoc şimdi, en azından Visual Studio Kanununda, desteklenir ve intellisense pop-up gösterir.