jsdoc:多行描述@property

问题描述 投票:4回答:2

我正在使用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.|
| ...   |         |                                 |

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

javascript documentation jsdoc jsdoc3
2个回答
6
投票

你必须使用br-Tags来解决新的新行:

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

1
投票
/**
 * @property {String} mode mode of display
 * <br>&nbsp;&nbsp;`video` - display video, or
 * <br>&nbsp;&nbsp;`audio` - plays only the audio
 * @property...
 */

实际产量:

enter image description here

© www.soinside.com 2019 - 2024. All rights reserved.