jsdoc：多行描述@属性

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

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

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

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

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

这个

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

结果为：

decription modes: I am foo I am bar

但是

这个

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

结果为：

decription

modes:

I am foo

I am bar

Answer 4

通过使用 minus 标志，您可以避免 <br>（而且在 vscode 中不起作用）

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

获取项目符号列表：

jsdoc：多行描述@属性

jsdoc: multiline description @property

javascript

documentation

jsdoc

jsdoc3