jsdoc:多行描述@property [英] jsdoc: multiline description @property

问题描述

我正在使用jsdoc记录我的代码，到目前为止，到目前为止，我有类似以下的评论

I am documenting my code using jsdoc, so far so good, I have a comment like below

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

，它出现在

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

希望我能使自己清楚...

hope I am making myself clear...

推荐答案

您必须使用br-标记来解析新的新行:

You have to use br-Tags to resolve new new lines:

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

这篇关于jsdoc:多行描述@property的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！