2

我是 Sails.js 和 Node.js 的新手，在为我的应用程序创建文档时遇到问题。

这是我的步骤：

  • 通过以下方式安装 apidoc： npm install apidoc -g
  • 安装的 grunt 模块： npm install grunt-apidoc --save-dev
  • 添加grunt.loadNpmTasks('grunt-apidoc');到底Gruntfile.js 部
  • 创建grunt.initConfig文件并放置：

apidoc: { myapp: { src: "api/controllers/", dest: "apidoc/" } }

然后我尝试运行多个东西，但它们都没有生成我的 api 文档：

  • 帆升降机
  • 咕哝
  • 咕噜默认
  • 节点应用程序.js

如果我手动运行它，apidoc -i api/controllers/ -o apidoc/它就可以正常工作。

我究竟做错了什么？怎么做？

4

1 回答 1

2

超级迟到的答案！

根据我修改资产管道的经验，你会更好：

  1. 像问题中一样安装 apidoc 和 Grunt 模块

  2. 在 `tasks/config/apidoc.js 中创建一个新文件：

    module.exports = function (grunt) {
    grunt.config.set('apidoc', {
    myapp: {
      src: "api/controllers/",
      dest: "apidoc/"
    }
  });
  grunt.loadNpmTasks('grunt-apidoc');
};

  3. 编辑tasks/register/compileAssets.js（或您希望任务运行的任何位置）：

    module.exports = function (grunt) {
  grunt.registerTask('compileAssets', [
    'clean:dev',
    'jst:dev',
    'less:dev',
    'copy:dev',
    'coffee:dev',
    'apidoc:myapp' // <-- This will now run every time your assets are compiled
  ]);
};

希望这可以帮助某人

于 2015-10-08T03:00:58.920 回答