2014-06-10 8 views
6

Gibt es ein Tool für Typescript, um automatisch Dokumentation aus kommentierten Kommentaren zu generieren?Dokumentations-Tool für TypeScript wie JSDoc

Ich versuchte mit JSDoc mit TypeScript. Es funktioniert bis zu einem gewissen Grad, aber sie sind einfach nicht dazu gedacht, zusammenzuarbeiten.

Irgendwelche Ideen/Vorschläge?

+1

Du hast Recht, JSDoc ist zur Zeit funktionieren könnte nicht mit Typoskript Dateien arbeiten, auch wenn sie zu JavaScript kompiliert sind. [JSDoc-Problem Nr. 272] (https://github.com/jsdoc3/jsdoc/issues/272) beschreibt einige der Kompatibilitätsprobleme. Es ist unwahrscheinlich, dass TypeScript-Unterstützung in naher Zukunft implementiert wird. –

+0

@JeffWilliams Dieser Artikel stammt aus dem Jahr 2012. Wissen Sie, ob es kürzlich Updates gab? Sie [unterstützen jetzt ECMAScript 6-Klassen] (http://usejsdoc.org/howto-es2015-classes.html). Aber wenn ich eine Typoskript-Klasse schreibe und sie nach ECMAScript 5 kompiliere, verliere ich das Schlüsselwort "Klasse". :-( –

Antwort

2

In meinem Wissen - noch nicht!

Allerdings gibt es jsdoc selbst planen, die Unterstützung für Typoskript bereitzustellen. Allerdings nicht sicher wann!