javascript – jsdoc：多行描述@property

我正在使用jsdoc记录我的代码,到目前为止很好,我有如下的评论

...
* @property {string}  mode -  mode of display 'video' - display video or 'audio' - play only the audio.
* @property...

它来自html文档之类的

| ...   |         |                                 
| mode  | string  | mode of display 'video' - display video or 'audio' - play only the audio.|
| ...   |         |                                 

我希望它看起来像

| ...   |         |                                 |
| mode  | string  | mode of display                 |
|       |         |   'video' - display video       |
|       |         |   'audio' - play only the audio.|
| ...   |         |                                 |

希望我清楚自己……

解决方法:

您必须使用br-Tags来解析新的新行：

mode of display <br>&nbsp&nbsp 'video' - display video <br>&nbsp&nbsp 'audio' - play only the audio. did the trick.

标签：javascript,documentation,jsdoc,jsdoc3
来源： https://codeday.me/bug/20190612/1223315.html