生成jsdoc文档

Question

我想了解如何使用jsdoc，这是一个用于生成JavaScript文档的工具。当我使用它时，我的所有文档文件都会出现在index.js中，而不是在我的文件、类或模块中的导航（在文档网站上）。此外，我还发现一些标签在文档中没有显示出来。然而，我只使用了usejsdoc网站提供的标签（jsdoc文档）。

版本信息： - 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'),

如何从我的代码生成JSDoc文档？

- Carman

Answer 1

我通过在 package.json 添加一个脚本来为典型的 JavaScript 项目添加 jsdocs。

"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。

- Harry Moreno