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

少しのグーグルから、実際にはテストしていません。

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