9
Gibt es einen Dokumentationsgenerator (kann ein Knotenpaket sein) wie in anderen Programmiersprachen (jsdoc/phpdoc/javadoc/..) für typoskriptbasierte Angular2-Projekte?Angular2 Documentation Generator
A
Antwort
11
Wenn Sie TypeScript verwenden, kann "Typedoc.org" für Sie nützlich sein. http://typedoc.org/
+0
Vielen Dank! Etwas wie das für NG2 wäre großartig, .. –
+0
der Link funktioniert nicht mehr –
+1
Ya, es wurde geschlossen. Ich werde einen anderen finden –
13
Dies scheint eine praktikable Lösung zu sein: compodoc
+0
Während dies die Frage theoretisch beantworten könnte, [wäre es vorzuziehen] (// meta.stackoverflow.com/q/8259), die wesentlichen Teile der Antwort hier aufzunehmen und den Link als Referenz zur Verfügung zu stellen. – BrokenBinary
+1
Ich fand compodoc-Projekt war die beste Lösung für den Fall, dass Sie ein angular2-Projekt haben. Die Dokumentation deckt alles ab, was Sie von guten Dokumenten erwarten können, Compodocs können angular2 Module/Klassen/Services/Annotations etc. identifizieren und strukturiert die Ausgabe entsprechend ... Außerdem fand ich den mitgelieferten Docs-Coverage Report sehr nützlich. Ich habe es nicht mit einem reinen Typoskript-Projekt versucht, ich denke, das würde wie die Ausgabe für 'reine' Klassen ohne Anmerkungen aussehen. – Florian
+0
Ich fand dieses Tool für mein Angular + TypeScript-Projekt am besten. – Xinan
dgeni https://github.com/rangle/angular2-dgeni-starter –
Ja, danke/danke, ich jetzt auch das Saatgut (https : //github.com/mgechev/angular2-seed) hat 'npm run build.docs'. Aber ich würde eine unabhängige Bibliothek/ein Paket/etc. Benötigen. –
Ich weiß nicht, wo Dgeny gepflegt wird. Ich habe gerade den Link zum Starter-Paket gepostet, weil ich davon ausgehe, dass es den ganzen Ingo bietet, wie man es benutzt. –