Grunt JSDoc:使用JSDoc JSON文件

Grunt JSDoc: Use jsdoc JSON file

本文关键字：JSDoc 文件 JSON Grunt 使用      更新时间：2023-09-26

我想设置一个Grunt任务来运行JSDoc。我正在使用grunt-jsdoc，这是JSDoc npm页面推荐的。它工作正常，但我不能使用我的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。jsdoc -c jsdoc.json

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

jsdoc: {
   dist: {
     options: {
          configure: './jsdoc.json'
       }
   }
}
相关文章：