2016-06-21 14 views
9

Czy istnieje generator dokumentacji (może być pakiet węzeł), tak jak w innych językach programowania (JSDoc/PHPDoc/javadoc/..) dla maszynopis opartych Angular2 projektach?Angular2 Dokumentacja Generator

+0

dgeni https://github.com/rangle/angular2-dgeni-starter –

+0

Ja, danke/dziękuję, teraz również to ziarno (https : //github.com/mgechev/angular2-seed) ma 'npm run build.docs'. Ale potrzebowałbym niezależnej biblioteki/pakietu/etc .. –

+0

Nie wiem, gdzie dgeny jest utrzymywane. Właśnie opublikowałem link do pakietu startowego, ponieważ założyłem, że zapewnia on całą ingo jak z niego korzystać. –

Odpowiedz

11

Jeśli używasz maszynopis następnie „Typedoc.org” może być przydatne dla Ciebie. http://typedoc.org/

+0

dziękuję! Coś w tym dla NG2 byłoby świetnie .. –

+0

link nie działa anymore –

+1

Ya, to zajechało zamknięte. Znajdę inny –

13

To wydaje się być dobrym rozwiązaniem: compodoc

+0

Chociaż może to teoretycznie odpowiedzieć na pytanie, [byłoby lepiej] (// meta.stackoverflow.com/q/8259), aby dołączyć istotne części odpowiedzi tutaj, i podać link dla odniesienia. – BrokenBinary

+1

Uważam, że projekt compodoc był najlepszym rozwiązaniem, jeśli masz projekt kątowy2. Dokumentacja obejmuje wszystko, czego można się spodziewać po dobrych dokumentach, compodocs może identyfikować moduły/klasy/usługi/adnotacje kątowe2 i odpowiednio strukturować dane wyjściowe ... Ponadto, okazało się, że dołączony raport docs-pokrycia jest bardzo użyteczny. Nie próbowałem tego z czystym projektem na maszynopis, wydaje mi się, że wyglądałoby to jak wyjście dla "czystych" klas bez adnotacji. – Florian

+0

Znalazłem to narzędzie najlepsze dla mojego projektu Angular + TypeScript. – Xinan