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

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

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

Answer 2

为此，您只需添加两个行空间 而不是一个 例如：

这个

output_lst = []

for dct in input_lst:
    tmp_dct = dct.copy()
    try:
    #replace/default any blank/null/space values and convert to datetime
        tmp_dct['exp_date'] = datetime.strptime(if dct['exp_date'] == "" then '01/01/1900' else dct['exp_date'], '%m/%d/%Y')
    except:
        pass
    #replace/default any blank/null/space values and convert to int
    try:
        tmp_dct['qty'] = int(if dct['qty'] == '' then '1' else dct['qty'])
    except:
    output_lst.append(tmp_dct)
print(output_lst)

结果为：

解密模式：我是foo，我是吧

但是

这个

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

结果为：

解密

模式：

我是傻子

我是酒吧

Answer 3

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

实际输出：