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

Question

我的任务是用正确的JSDoc记录功能。当函数返回 true 时会触发某些内容，否则它不会触发。但无论如何，返回值必须是布尔类型。

我的变体是：

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

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

Answer 1

我在可能的返回值下面添加了一行：

* @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.

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