jsdoc: multiline description @property

前端 未结 3 795
星月不相逢
星月不相逢 2021-01-12 20:20

I am documenting my code using jsdoc, so far so good, I have a comment like below

...
* @property {string}  mode -  mode of display \'video\' - display video         


        
3条回答
  •  情话喂你
    2021-01-12 21:06

    for this you can simply add two line spaces instead of one for example:

    this

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

    results to :

    decription modes: I am foo I am bar

    But

    this

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

    results to :

    decription

    modes:

    I am foo

    I am bar

提交回复
热议问题