【问题标题】：JSDoc: how to specify optional return value properlyJSDoc：如何正确指定可选的返回值
【发布时间】：2017-01-27 13:03:39
【问题描述】：
我的任务是用正确的 JSDoc 记录函数。当函数返回 true 时，它会触发某些东西，否则不会。但无论如何，返回值必须是布尔类型。
我的变种是：
* @return {boolean=false} trigger for default event handler:
*
* Value | Description
*-------|-------------------------------
* true | disable default event handler
* false | enable default event handler
请帮助我选择正确的解决方案。谢谢！
【问题讨论】：
标签：
javascript
documentation
jsdoc
【解决方案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.
我认为这是最好的解决方案，因为它清晰有效。