node.js - JSDocs：记录 Node.js 快速路由

Question

我正在努力用 JSDocs 记录 router.get 调用。如果我尝试将文档附加到我的路由器调用本身，我无法让文档在页面上正确显示。

/**
 * Health check
 * @memberof health
 */
router.get('/happy', function(req, res) {
    res.json({ "status" : "OK" });
});

为了解决这个问题，我为函数命名。

router.get('/happy', happy);

/**
 * Health check
 * @memberof health
 */
function happy(req, res) {
    res.json({ "status" : "OK" });
}

这行得通，但我真的很想找到一种方法来让第一种方法起作用。有没有办法记录第一个例子？我可以使用的关键字？

Answer 1

我在我的代码中执行以下操作。

/** Express router providing user related routes
 * @module routers/users
 * @requires express
 */

/**
 * express module
 * @const
 */
const express = require('express');

/**
 * Express router to mount user related functions on.
 * @type {object}
 * @const
 * @namespace usersRouter
 */
const router = express.Router();

/**
 * Route serving login form.
 * @name get/login
 * @function
 * @memberof module:routers/users~usersRouter
 * @inner
 * @param {string} path - Express path
 * @param {callback} middleware - Express middleware.
 */
router.get('/login', function(req, res, next) {
  res.render('login', {title: 'Login', message: 'You must login'});
});

输出是： 截图

Answer 2

从一点点谷歌搜索，还没有实际测试过。

/**
 * Health check
 * @memberof health
 * @function
 * @name happy
 */
router.get('/happy', function(req, res) {
    res.json({ "status" : "OK" });
});

Answer 3

如果你不把“@module moduleName ”放在文件的顶部，jsdoc将不会引用页面上的其他评论，因为他们没有父@module