2016-05-09 47 views
9

Ho un po 'di esperienza con angular 2, ma sono ancora relativamente nuovo per il Framework. Guardandomi intorno, ho scoperto qualcosa chiamato ngdocs. È molto bello perché crea una sorta di area di documentazione/wiki in base ai commenti nel tuo codice. (simile a js docs). Tuttavia, sembra essere scritto esclusivamente per l'uso con l'angolare 1.XX.Documentazione angolare 2/esiste un ngdocs per l'angolare 2?

Ho fatto qualche ricerca in giro, ma non riesco a trovare nulla che possa fornire funzionalità simili per l'angolare 2. Qualcuno sa se c'è qualcosa di simile a ng-docs per l'angolare 2?

+0

Alcune cose da notare: - Sto usando angolare 2 con dattiloscritto. - Ho provato a usare ngdocs con angular 2. Non posso davvero usarlo perché: 1. La documentazione generata utilizza l'angolare 1. 2. Il compilatore dattiloscritto spesso spoglia i commenti (devono essere in determinate aree). 3. il tag @ngdoc non mi permette di organizzare i documenti in un modo che abbia senso per l'angolare 2. (es. Creare errori sul tag del componente) Inoltre, sto usando ngdocs con gulp. –

risposta

4

L'unica cosa che ho trovato finora è TypeDoc. Non è specifico per l'angolare ma creerà una documentazione per te basata sul dattiloscritto. Sembra che manchi l'abilità di fare certe cose a cui potresti essere abituato con ngDoc (esempi dal vivo e simili).

3

C'è anche un progetto chiamato Compodoc (https://medium.com/vincent-ogloblinsky/compodoc-documentation-tool-for-angular-2-applications-44ec650e01a8), che genera documentazione specifica per Angular 2/4.

Utilizzano i commenti normali e hanno anche aggiunto il supporto della sintassi del markdown.

+1

questo è quello che uso anche adesso. è molto bello – Jason

+0

l'unica cosa che mi manca è la possibilità di aggiungere pulsanti demo e collegarli a componenti personalizzati. –