Tag: autodoc

用jsdocloggingcallback的正确方法是什么？

我花了很长一段时间在互联网上寻找最好的方式来正确loggingjsdoc的callback，但不幸的是，我还没有find一个好的方法。 这是我的问题： 我正在为开发人员编写一个Node.js库。 这个库提供了开发人员将要使用的多个类，函数和方法。 为了使我的代码清晰易懂，以及（希望）将来会自动生成一些API文档，我已经开始在代码中使用jsdoc来自我logging正在发生的事情。 比方说，我定义了一个如下的函数： function addStuff(x, y, callback) { callback(x+y); }); 使用jsdoc，我目前正在logging这个函数，如下所示： /** * Add two numbers together, then pass the results to a callback function. * * @function addStuff * @param {int} x – An integer. * @param {int} y – An integer. * @param {function} callback – A callback to run […]