JSDocs: Ghi lại các tuyến đường cao tốc Node.js

Question

Tôi đang gặp khó khăn trong việc ghi lại các cuộc gọi router.get với JSDocs. Tôi không thể tải tài liệu để hiển thị chính xác trên trang nếu tôi cố gắng thêm nó vào chính cuộc gọi của bộ định tuyến.

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

Để giải quyết, tôi đã thực hiện các chức năng có tên.

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

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

Công trình này, nhưng tôi thực sự muốn tìm cách để có phương pháp đầu tiên hoạt động. Có cách nào để ghi lại ví dụ đầu tiên không? Một từ khóa tôi có thể sử dụng?

Answer 1

Từ một chút Googling, chưa thực sự thử nghiệm.

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

Answer 2

Tôi làm như sau trong mã của mình.

/** 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'}); 
}); 

Và kết quả là: Screenshot