Angular 2: Dokumentation mit Compodoc

Angular2-Entwickler mussten lange auf ein brauchbares Dokumentationstool warten. Mit Compodoc steht nun ein großartiger Generator zur Verfügung, der nicht nur ansprechend daher kommt, sondern auch eine Menge nützlicher Features bietet. Compodoc wird stetig weiter entwickelt, ist allerdings schon jetzt sehr ausgereift.

Als erstes fällt natürlich die Übersicht ins Auge, welches alle Module, Komponenten und Services Eurer Applikation in hierarchischer Form darstellt. Die Übersicht ist bei großen Applikationen zwar nicht mehr wirklich übersichtlich, aber trotzdem ein Blickfang. Je Modul findet Ihr jeweils noch einmal eine kleinere Version dieser Übersicht im Bezug auf eben jenes Modul.

Neben diversen Themes, die natürlich alle im Responsive Design daher kommen, gibt es eine ganz brauchbare Suchfunktion und die Möglichkeit weitere eigene Dokumentation in Form von Markdown-Dateien mit einzubinden. Dadurch bietet sich an die komplette Dokumentation innerhalb des Projektes zu verwalten und ggf. auch mit zu versionieren.

Compodoc ist als Node-Modul konzipiert und kann deshalb einfach über npm herunter geladen werden. Hier bietet es sich natürlich an das Tool global zu installieren:

$ npm install -g @compodoc/compodoc

Dokumentation kann dann mit einem einfachen Befehl generiert werden:

$ compodoc -p tsconfig.json -s

Eine detailliertere Dokumentation findet Ihr auf der offiziellen Seite von Compodoc. Als Alternative bietet sich übrigens TypeDoc an. Hier ist allerdings zu beachten, dann TypeDoc in erster Linie für reine TypeScript-Projekte gedacht ist und nicht wirklich gut mit Angular 2 funktioniert.