Javascript 生成jsdoc文档

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

版本：

• Node.js:6.9.1
• jsdoc:3.4.2

Server.js

"use strict";
/**
 * @module server
 * @file
 * The main file of this server. It create access routes. To use it, you can write on a terminal : $ node server.js                                 <br />
 * Turn in javascript strict mode.                                                                                                                  <br />
 * 
 * @version    1.0
 * @since      1.0
 *
 * @requires config
 * @requires express
 * @requires body-parser
 * @requires messenger.scenario
 * @requires messenger.routeMessenger
 */
const 
    // Official libraries
    /**
     * @access        public
     * @constant
     * @description   Use config file to param server.
     */
    config       =   require("config"),
    express      =   require('express'),
    bodyParser   =   require('body-parser'),

“严格使用”；
/**
*@模块服务器
*@file
*此服务器的主文件。它创建访问路径。要使用它，您可以在终端上写入：$node server.js

*在javascript严格模式下打开

* 
*@version 1.0
*@自1.0以来
*
*@需要配置
*@需要快递
*@需要正文分析器
*@requires.messenger
*@requires messenger.routeMessenger
*/
常数
//官方图书馆
/**
*@access-public
*@常数
*@description将配置文件用于参数服务器。
*/
config=require（“config”），
express=require（'express'），
bodyParser=require（'body-parser'），

我希望你能帮助我

---

致以最诚挚的问候

我通过向

package.json添加脚本，将jsdocs添加到典型的javascript项目中

"scripts": {
  ...
  "docs": "./node_modules/jsdoc/jsdoc.js -c ./.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
  }
}

并添加一个配置文件

.jsdoc.conf.json

"scripts": {
  ...
  "docs": "./node_modules/jsdoc/jsdoc.js -c ./.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

生成项目文档

---

您可能还希望忽略生成的文档。有关完整配置选项，请阅读

请接受我的回答