When the parameters of a function use deconstructed objects, how to write jsDoc? for them

problem description

when I use deconstruction assignment in the parameters of a function, how should I write the corresponding jsDoc, so that IDE can prompt the content correctly?
Thank you in advance for all the excellent respondents who participated in the answer!

related codes 

......
/**
 * Avg
 */
class Avg {
  /**
   * 
   * @param {Object} [p]  < jsDocVSCAvg
   * @param {HTMLCanvasElement} [p.target]  < 
   * @param {number} [p.height = 720] canvas < 
   * @param {number} [p.width = 1280] canvas < 
   * @param {string} [p.color = con.DEFUALT_COLOR]  < 
   */
  constructor ({
    target = undefined, // canvas
    width = con.DEFUALT_DRAWING_BOARD_WIDTH, // 
    height = con.DEFUALT_DRAWING_BOARD_HEIGHT, // 
    color = con.DEFUALT_COLOR // 
  } = {}) {
    /**
     * 
     * @type {string}
     */
    this.color = color
    .....

current effect and expected effect

it is useless to talk too much. Please see the figure
the expected effect


50

.
Javascript typescript
Sep.06,2021

you can write a separate
.d.ts file
use interface to define an interface for the representation of parameters here
example
https://github.com/iamapig120.

interface Table {
  /**
   * GetSelectkeyvalue
   * @returns Promiseresolve
   */
  get(p: {
    /**
     * keyvalue
     */
    params?: { [x: string]: string | null | number }
    /**
     * keyvalueASCfalseDESCtrueASC
     */
    orderBy?: { [x: string]: boolean }
    /**
     * 
     */
    columns?: Array<string>
    /**
     *  2 
     */
    limit?: [
      /**
       * 
       */
      number,
      /**
       * 
       */
      number
    ]
  }): Promise<any>
...

here params,orderBy,columns,limit is regarded as the property of the first parameter object p of the get method of Table, and the return type of the method is Promise , that is, an instantiated Promise object

.

Previous: How to install the webpack-dev-server? corresponding to the specified version of webpack

Next: Ask how to use the scanf function. What happened to this program?

css mysql arrays josn react html typescript webpack npm sass R objective-c .net sql-server jquery python-3.x angularjs django angular excel regex iphone ajax linux xml pandas vba spring database wordpress string wpf xcode windows bash postgresql oracle multithreading eclipse list firebase algorithm macos forms image scala visual-studio azure bootstrap spring-boot react-native python-2.7 docker performance function winforms matlab powershell apache dataframe api sqlite numpy rest shell selenium flutter dart maven loops qt swing android-studio csv express file class tensorflow sorting codeigniter perl
© 2021 CodesHelper
Advertising Contact us About us
Menu