javascript - Angular 2 documentationis there an ngdocs for angular 2? - Stack Overflow

admin管理员组

文章数量:1379438

I have a bit of experience with angular 2, but I'm still relatively new to the Framework. While looking around, I discovered something called ngdocs. It's very nice because it creates a sort of documentation / wiki area for you based on the ments in your code. (similar to js docs). However, it seems to be written exclusively for use with angular 1.XX.

I've done some searching around, but can't seem to find anything that would provide similar functionality for angular 2. Does anyone know if there is something similar to ng-docs for angular 2?

I have a bit of experience with angular 2, but I'm still relatively new to the Framework. While looking around, I discovered something called ngdocs. It's very nice because it creates a sort of documentation / wiki area for you based on the ments in your code. (similar to js docs). However, it seems to be written exclusively for use with angular 1.XX.

I've done some searching around, but can't seem to find anything that would provide similar functionality for angular 2. Does anyone know if there is something similar to ng-docs for angular 2?

• javascript
• angular

Share Improve this question Follow edited Dec 27, 2017 at 11:41 Alejandro Morán 71911 gold badge1515 silver badges3838 bronze badges asked May 9, 2016 at 15:44 Ryan La ForgeRyan La Forge 26111 silver badge44 bronze badges 1

• Some things to note: - I'm using angular 2 with typescript. - I've tried using ngdocs with angular 2. I can't really use it because: 1. The generated documentation is using angular 1. 2. The typescript piler often strips ments (they need to be in certain areas). 3. the @ngdoc tag does not let me organize the docs in a way that make sense for angular 2. (i.e. build errors on ponent tag) Also, I'm using ngdocs with gulp. – Ryan La Forge Commented May 9, 2016 at 15:57

Add a ment  | 

2 Answers 2

Sorted by: Reset to default 4

The only thing I have found so far is TypeDoc. It is not specific to angular but it will create some documentation for you based off of the typescript. It does appear to lack the ability to do certain things you may be used to with ngDoc (live examples and such).

There is also a project called Compodoc (https://medium./vincent-ogloblinsky/podoc-documentation-tool-for-angular-2-applications-44ec650e01a8), which generates documentation specific for Angular 2/4.

They are using normal ments and have added support of markdown syntax as well.

本文标签： javascriptAngular 2 documentationis there an ngdocs for angular 2Stack Overflow