JSDoc：オプションの戻り値を正しく指定する方法

Question

私の仕事は、正しいJSDocで関数をドキュメント化することです。関数がを返した場合、がトリガされます。そうでない場合、トリガされません。しかし、いずれの場合でも、戻り値はブール型でなければなりません。

私の変異体である：私は喜ば

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

ヘルプは、適切なソリューションを選択します。ありがとう！

Answer 1

私は単に可能な戻り値以下の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. 

を。