目前正在处理一些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/: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记录路线的正确方法?任何建议将不胜感激。谢谢!