我想设置一个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

最佳答案

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

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

关于javascript - Grunt JSDoc:使用jsdoc JSON文件,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/31859823/

10-16 23:26