Javascript JSDoc:如何正确指定可选返回值

Javascript JSDoc:如何正确指定可选返回值,javascript,documentation,jsdoc,Javascript,Documentation,Jsdoc,我的任务是用正确的JSDoc记录函数。当函数返回true时,它会触发某些内容,否则不会触发。但在任何情况下,返回值都必须是布尔类型 我的变体是: * @return {boolean=false} trigger for default event handler: * * Value | Description *-------|------------------------------- * true | disable default event handler * false | e

我的任务是用正确的JSDoc记录函数。当函数返回true时,它会触发某些内容,否则不会触发。但在任何情况下,返回值都必须是布尔类型

我的变体是:

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

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

我只是在可能的返回值下面添加了一行:

* @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.
我认为这是最好的解决办法,因为它是明确和有效的