在javascript中记录传递给回调的参数的约定是什么？

当使用javadoc样式的文档化样式时，是否有一个约定来记录传递给回调函数的参数

/**
 * @param cb {Function} A callback that will be passed a name (String) and a Number
/

---

这与事件的关系比回调更密切，但我想发布它，因为它可能会在相关情况下帮助您。如果在调用回调时也触发事件，则可以使用此方法记录事件，然后在回调文档中，注意它接收与事件相同的参数，并使用@link链接到事件

我使用类似于您在下面看到的内容来记录中的事件。它没有连接到任何特定代码，我将它转储在定义F组件的脚本底部：

/**
 * Triggered when this component is shown
 *
 * @name F.Component#component:shown
 * @event
 *
 * @param {Object}  evt                 Event object
 * @param {String}  evt.name            This component's name
 * @param {F.Component} evt.component   This component
 */

当使用JSDoc工具包构建时，上面的JSDoc语句会产生一个错误。基本上，您会得到一个很好的事件详细信息部分，它描述了事件何时被触发以及向回调传递了哪些参数。这也适用于JSDoc3，并生成具有相同信息的事件部分

---

请注意，并没有确切地描述以这种方式使用它，但它确实提供了所需的输出。就JSDoc3而言，和标记还没有文档，但是@event确实提供了我想要的输出。

建议使用

{function（String，Number）}

。不保证您的IDE支持此功能。谢谢！我更关心约定，而不是与特定IDE的兼容性。我喜欢它！但我不确定这是否是惯例（如果有惯例的话）