2014-06-06 83 views
4

我有一個使用gulp運行任務(如構建,棉絨等)的離子項目。 。使用gulp進行角/離子項目的doc生成

現在我想創建適當的文件很好,但面臨的問題是jsdoc不與角框架發揮出色。

還有一個叫做的工具,但這個工具只適用於grunt

有沒有人有合適的解決方案來創建角項目的文檔?

(它musn't與一飲而盡直接合作,東西從命令行運行將是完美的罰款)

編輯:迷迷糊糊起來上​​這似乎是進入正確的方向但並不是真正處於開發階段,因爲它可用於我寫這篇文章的時間。

回答

3

這可能有點晚,但我可以通過安裝angular-jsdoc NPM插件(https://www.npmjs.org/package/angular-jsdoc)來解決此問題。我遇到了同樣的問題,想要在支持我的移動應用程序的Ionic Framework中記錄我的Angular腳本。安裝後,我有一個大口任務設置用於產生角文檔:

gulp.task('angular-documentation', shell.task([ 
     'node node_modules/angular-jsdoc/node_modules/jsdoc/jsdoc.js' + 
     ' -c node_modules/angular-jsdoc/conf.json ' + 
     ' -t node_modules/angular-jsdoc/template ' + 
     ' -d dev-docs ' + 
     ' -r www/app' 
    ])); 

任務的每個部分被表示爲如下:

  • 第一弦線部分(node後)表示的路徑安裝角jsdoc
  • 表示其中角-jsdoc插件的conf.json駐留
  • -t標誌部的-c標誌部分表示其中角jsdoc插件的模板文件夾所在
  • 其中生成文檔的-d部分
  • 代表您的角度腳本文件駐留在-r標誌部分。

如果你設置的Node.js和您的節點具有默認配置的插件,除了-d標誌和-r標誌部分外,您不必擔心更改任何內容。

+0

看起來非常好,我會盡快嘗試!謝謝! – Ostkontentitan