2016-05-09 13 views
9

Ich habe ein wenig Erfahrung mit angular 2, aber ich bin noch relativ neu im Framework. Während ich mich umsah, entdeckte ich etwas namens ngdocs. Es ist sehr schön, weil es basierend auf den Kommentaren in Ihrem Code eine Art Dokumentations-/Wiki-Bereich für Sie erstellt. (ähnlich zu js docs). Es scheint jedoch ausschließlich für den Gebrauch mit eckigen 1.XX geschrieben zu sein.Angular 2 Dokumentation/gibt es ein ngdocs für angular 2?

Ich habe ein wenig herumgesucht, kann aber nichts finden, was ähnliche Funktionalität für eckige 2 bieten würde. Weiß jemand, ob es etwas Ähnliches wie ng-docs für angular 2 gibt?

+0

Einige Dinge zu beachten: - Ich benutze Winkel 2 mit Typoskript. - Ich habe versucht mit ngdocs mit eckigen 2. Ich kann es nicht wirklich verwenden, weil: 1. Die generierte Dokumentation verwendet Winkel 1. 2. Der Typescript-Compiler oft Kommentare (sie müssen in bestimmten Bereichen sein). 3. Das @ ngdoc-Tag lässt mich die Dokumente nicht auf eine Weise organisieren, die für Winkel 2 sinnvoll ist. (D. H. Build-Fehler am Komponenten-Tag) Auch ich verwende ngdocs mit Schluck. –

Antwort

4

Das einzige, was ich bisher gefunden habe, ist TypeDoc. Es ist nicht spezifisch für eckig, aber es wird eine Dokumentation für Sie basierend auf dem Typoskript erstellen. Es scheint zu fehlen die Fähigkeit, bestimmte Dinge zu tun, die Sie mit ngDoc gewohnt sind (Live-Beispiele und so).

3

Es gibt auch ein Projekt namens Compodoc (https://medium.com/vincent-ogloblinsky/compodoc-documentation-tool-for-angular-2-applications-44ec650e01a8), das Dokumentation speziell für Angular 2/4 erzeugt.

Sie verwenden normale Kommentare und haben auch die Unterstützung der Markdown-Syntax hinzugefügt.

+1

das benutze ich jetzt auch. Es ist sehr cool. – Jason

+0

die einzige Sache, die ich vermisse, ist eine Möglichkeit, Demo-Schaltflächen hinzuzufügen und sie mit benutzerdefinierten Komponenten zu verknüpfen. –