Grunt JSDoc：使用 jsdoc JSON 文件答案

【问题标题】：Grunt JSDoc: Use jsdoc JSON fileGrunt JSDoc：使用 jsdoc JSON 文件
【发布时间】：2015-10-29 20:11:45
【问题描述】：

我想设置一个 Grunt 任务来运行 JSDoc。我正在使用 JSDoc npm 页面推荐的 grunt-jsdoc。它工作正常，但我无法使用我创建的 jsdoc.json 文件。

{
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc","closure"]
  },
  "source": {
    "include": [
      "lib/",
      "routes/",
      "README.md"
    ]
  },
  "plugins": ["plugins/markdown"],
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false
  },
  "opts": {
    "destination": "public/docs"
  }
}

我发现当我从 JSDoc 中提取一些内容并将它们放入 Grunt 时，我没有任何问题：

//This will generate a blank public/docs folder
jsdoc: {
    dist : {
        src: './jsdoc.json'
        options: {
            destination: 'public/docs'
        }
    }
}

我希望能够仅引用 JSON 文件并让它工作。目前，这样做不会产生错误，但除了在基目录中创建一个空的 doc 文件夹之外，它不会做任何事情。

jsdoc: {
    dist : {
        src: './jsdoc.json'
    }
}

我也验证了jsdoc.json文件是正确的jsdoc -c jsdoc.json

【问题讨论】：

标签： javascript gruntjs jsdoc

【解决方案1】：

您需要将conf文件放入options属性中。

jsdoc: {
   dist: {
     options: {
          configure: './jsdoc.json'
       }
   }
}

【讨论】：