我對angular 2有一些經驗,但我對框架還比較陌生。在環顧四周時,我發現了一些名爲ngdocs的東西。這非常好,因爲它根據代碼中的註釋爲您創建了一個文檔/ wiki區域。 (類似於js文檔)。但是,它似乎專門用於角度1.XX。Angular 2文檔/是否有角2的ngdocs?
我已經做了一些搜索,但似乎無法找到任何可以提供類似的角度2功能的東西。有沒有人知道是否有類似ng-docs for angular 2的東西?
我對angular 2有一些經驗,但我對框架還比較陌生。在環顧四周時,我發現了一些名爲ngdocs的東西。這非常好,因爲它根據代碼中的註釋爲您創建了一個文檔/ wiki區域。 (類似於js文檔)。但是,它似乎專門用於角度1.XX。Angular 2文檔/是否有角2的ngdocs?
我已經做了一些搜索,但似乎無法找到任何可以提供類似的角度2功能的東西。有沒有人知道是否有類似ng-docs for angular 2的東西?
我迄今爲止發現的唯一的事情是TypeDoc。它不是特定的角度,但它會根據打字稿爲您創建一些文檔。它看起來似乎缺乏你可能習慣的某些事情的能力(例如實例等)。
還有一個名爲Compodoc的項目(https://medium.com/vincent-ogloblinsky/compodoc-documentation-tool-for-angular-2-applications-44ec650e01a8),它生成特定於Angular 2/4的文檔。
他們正在使用正常的評論,並增加了對markdown語法的支持。
這也是我現在使用的。它非常酷。 – Jason
我唯一想念的是添加演示按鈕並將它們鏈接到自定義組件的可能性。 –
有些事情要注意: - 我正在使用angularScript 2與打字稿。 - 我嘗試過使用帶有角度2的ngdocs。我無法真正地使用它,因爲: 1.生成的文檔使用的是角度1.2.打字稿編譯器經常會刪除註釋(它們需要位於某些區域)。 3. @ngdoc標籤不允許我以對角度2有意義的方式組織文檔。(即構建組件標籤時出錯) 另外,我使用ngdocs和gulp。 –