JSDoc：如何正确指定可选的 return 值

Question

我的任务是使用正确的 JSDoc 记录函数。当 function returns true 时它会触发一些东西，否则它不会。但无论如何 return 值必须是布尔类型。

我的变体是：

* @return {boolean=false} trigger for default event handler:
*
* Value | Description
*-------|-------------------------------
* true  | disable default event handler
* false | enable default event handler

请帮我选择正确的解决方案。谢谢！

Answer 1

我在可能的 return 值下方添加了一行：

* @return {boolean} trigger for default event handler:
*
* Value | Description
*-------|-------------------------------
* true  | disable default event handler
* false | enable default event handler
*
* Return `false` or nothing if you want that default event handler stayed untouched.

我认为这是最好的解决方案，因为它清晰有效。

JSDoc：如何正确指定可选的 return 值

JSDoc: how to specify optional return value properly

javascript

documentation

jsdoc