Questions tagged «jsdoc3»

如何将返回的对象的结构告诉JSDoc。我找到了@return {{field1: type, field2: type, ...}} description语法并尝试了它： /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * event. * @param {string} [type="page"] * A string representing the type of …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

我已经花了相当长的时间在互联网上寻找可使用jsdoc正确记录回调的最佳方法，但是不幸的是，我还没有找到一个好的方法。 这是我的问题： 我正在为开发人员编写Node.js库。该库提供了开发人员将要使用的多个类，函数和方法。 为了使我的代码清晰易懂，并在将来（希望）自动生成一些API文档，我开始在代码中使用jsdoc自行记录正在发生的事情。 假设我定义了如下函数： function addStuff(x, y, callback) { callback(x+y); }); 目前，使用jsdoc，我正在将此功能记录如下： /** * 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 - …

76 javascript  node.js  jsdoc  autodoc  jsdoc3