JSDocs：loggingNode.jsexpression路由

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

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

为了解决这个问题，我让function有了名字。

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

这工作，但我真的想find一种方法来获得第一个方法的工作。 有没有办法logging第一个例子？ 我可以使用的关键字？

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} middlewear - Express middlewear. */ router.get('/login', function(req, res, next) { res.render('login', {title: 'Login', message: 'You must login'}); }); 

输出是： Screenshot

Answer 2

从一点谷歌search，还没有实际testing。

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