jsdoc正确的方式来loggingsocket.on（'event'，function（）{}）和路由处理程序

如何使用具有以下格式的jsdoc来loggingAPI（单个文件）

// api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Object} data Some data * @param {string} data.bla Something about bla * @param {number} data.n Some number */ socket.on('something_1', function(data) { ... }); /** * Another function that will do .. * @param {string} id of something */ socket.on('something_2', function(id) { ... }); ... }; exports.addRoutes = function(app) { /** * PATCH /something/:id/juhu * Will do this and that and will respond with ... * @param {string} _id Id of bonus document */ app.patch('/something/:id/juhu', function(req, res) {...}); /** * GET /something * Will fetch and respond back with ... */ app.get('/something', function(req, res) {...}); ... }; 

我唯一的想法是在出口上方添加@namespace ，在匿名函数上面添加@lends ，但是这会导致文档为空。

Answer 1

我正在使用Angular，然后是JSDoc的Angular doc。 因此，我正在logging我的父类和function类似于以下内容。

 /** * @class MyApp.Teams * @ngdoc class * @memberOf MyApp * @description * Module to handle the interface to the Teams, data and views. */ angular.module('MyApp').factory( ... /** * @name TeamRecord * @ngdoc factory * @memberOf MyApp.Teams * @returns Record Clears the Structure to "" * @description * Team Data Record structure */ 

所以，上面的文字可能是这样的：

 /** * @class MyApp.socketio * @ngdoc class * @memberOf MyApp * @description * Module to handle the interface to the Teams, data and views. */ /** * @name addSocketEvens * @ngdoc function * @memberOf MyApp.socketio * @param {Object} data Some data * @param {string} data.bla Something about bla * @param {number} data.n Some number * @description * This will do that and ... */ exports.addSocketEvents = function(socket) { socket.on('something_1', function(data) { ... }); /** * Another function that will do .. * @param {string} id of something */ socket.on('something_2', function(id) { ... }); ... }; /** * @name addRoutes * @ngdoc function * @memberOf MyApp.socketio * @param {string} _id Id of bonus document * @description * Will do this and that and will respond with ... */ exports.addRoutes = function(app) { app.patch('/something/:id/juhu', function(req, res) {...}); /** * GET /something * Will fetch and respond back with ... */ app.get('/something', function(req, res) {...}); ... };