2014-06-06 14 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