Javascript 如何使用JSDoc记录路由参数?
目前正在为一个javascript项目编写一些文档,我想记录以下内容:Javascript 如何使用JSDoc记录路由参数?,javascript,express,jsdoc,Javascript,Express,Jsdoc,目前正在为一个javascript项目编写一些文档,我想记录以下内容: /** * Express router to mount admin related functions on. * @namespace AdminRoutes */ const router = express.Router() /** * Finds an admin based on the admin id stored in the session. * @function * @name get/
/**
* Express router to mount admin related functions on.
* @namespace AdminRoutes
*/
const router = express.Router()
/**
* Finds an admin based on the admin id stored in the session.
* @function
* @name get/:adminId
* @memberof AdminRoutes
* @param {string} adminId - The id of the admin to get.
* @returns {Object} Returns an Admin object.
*/
router.get('/:adminId', async (request, response, next) => {
try {
return response.json(await Admin.findOne(request.session.user.id))
} catch (error) {
return next(error)
}
})
如果这是一个普通函数,那么这将完全正常工作,但是当作为路由记录时,生成文档显示为一个名为“get”的普通函数,adminId作为参数。在命名函数时,JSDoc几乎不考虑@name字段。有没有办法解决这个问题,或者用params记录路由的正确方法?如有任何建议,将不胜感激。谢谢 有点晚了,但是检查一下,可能会有帮助@Rodrigo.A92我非常喜欢这个解决方案,谢谢!