2014-06-10 35 views
6

Czy istnieje narzędzie do automatycznego generowania dokumentacji z komentarzy z przypisami?Narzędzie do dokumentacji dla TypeScript, takie jak JSDoc

Próbowałem używać JSDoc z TypeScript. Działa do pewnego stopnia, ale po prostu nie mają ze sobą współpracować.

Wszelkie pomysły/sugestie?

+1

masz rację, JSDoc nie pracuje obecnie z plikami maszynopis, nawet jeśli są one skompilowane do JavaScript. [Problem JSDoc nr 272] (https://github.com/jsdoc3/jsdoc/issues/272) opisuje niektóre problemy ze zgodnością. Obsługa języka TypeScript jest mało prawdopodobne, aby zaimplementować w najbliższym czasie. –

+0

@JeffWilliams Ten artykuł pochodzi z 2012 roku. Czy wiesz, czy były jakieś najnowsze aktualizacje na ten temat? Oni [obsługują teraz klasy ECMAScript 6] (http://usejsdoc.org/howto-es2015-classes.html). Ale jeśli napiszę klasę maszynopisu i skompiluję ją do ECMAScript 5, stracę słowo kluczowe "klasa". :-( –

Odpowiedz

2

Według mojej wiedzy - jeszcze nie!

Jednak sami jsdoc planują wsparcie dla maszynopisu. Jednak nie wiem kiedy!