jsdoc:多行描述@property
mid*_*ido 4 javascript documentation jsdoc jsdoc3
我正在使用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.|
| ... | | |
希望我清楚自己......
ʞᴉɯ*_*ʞᴉɯ 23
通过使用minus符号你可以避免<br>（而且不能在 vscode 中工作）
/**
* @property {String} editMode editing mode
* - A: description for A
* - B: description for B
* - C: description for C
*/
获取项目符号列表：
小智 10
为此，您可以简单地添加两个行空格而不是一个，例如：
这
/**
* decription
* modes:
* I am foo
* I am bar
*/
结果：
描述模式： 我是 foo 我是 bar
但
这
/**
* decription
*
* modes:
*
* I am foo
*
* I am bar
*
*/
结果：
描述
模式：
我是富
我是酒吧
小智 7
/**
* @property {String} mode mode of display
* <br> `video` - display video, or
* <br> `audio` - plays only the audio
* @property...
*/
实际输出：
您必须使用br-Tags来解析新的新行:
mode of display <br>   'video' - display video <br>   'audio' - play only the audio. did the trick.
- 这无助于避免源文件**中的长行**. (5认同)