javascript - jsdoc：多行描述@property

Question

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

希望我说清楚...

Answer 1

通过使用minus符号可以避免<br>（而且不在 vscode 中工作）

  /**
   * @property {String} editMode editing mode
   * - A: description for A
   * - B: description for B
   * - C: description for C
   */

获取项目符号列表：

Answer 2

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

实际输出：

Answer 3

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

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

Answer 4

为此，您可以简单地添加两个行空格而不是一个，例如：

这个

/**
 * decription
 * modes:
 * I am foo
 * I am bar
 */

结果：

解密模式：I am foo I am bar

但

这个

 /**
 * decription
 * 
 * modes:
 * 
 * I am foo
 * 
 * I am bar
 * 
 */

结果：

描述

模式：

我是富

我是酒吧