生成jsdoc文档

Question

我搜索了解如何操作jsdoc，javascript文档的生成器。当我使用它时，我总是在index.js上的所有文档文件，而不是我的文件，类或模块中的导航（在文档网站中）。此外，我还有一些标签没有出现在文档中。但是，我只使用usejsdoc网站（documentation of jsdoc）提供的标签。

版本：

• Node.js：6.9.1
• jsdoc：3.4.2

Server.js

dipslay:flex;

我希望你能帮助我。

祝你好运

Answer 1

我通过向package.json

添加脚本将jsdocs添加到典型的javascript项目中

"scripts": {
  ...
  "docs": "./node_modules/jsdoc/jsdoc.js -c ./.jsdoc.conf.json"
}

并添加配置文件.jsdoc.conf.json

{
  "plugins": [],
  "recurseDepth": 10,
  "opts": {
    "recurse": true,
    "destination": "./docs/"
  },
  "source": {
    "include": ["src"],
    "includePattern": ".+\\.js(doc|x)?$",
    "excludePattern": "node_modules"
  },
  "sourceType": "module",
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc", "closure"]
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false
  }
}

这会在项目根目录中的./docs文件夹中生成文档。

然后，您可以通过运行npm run docs生成项目文档。

您可能还想gitignore生成的文档。有关完整配置选项，请阅读http://usejsdoc.org/about-configuring-jsdoc.html