带有默认参数的函数的 JSDoc

Question

我使用 JSDoc @param 注释创建函数描述如下（使用 Visual Studio“添加 jsdoc 注释”插件）。但是对于函数的默认参数，它的数据类型并不附带。即使我检查了 JSDoc，我也没有发现这是否是描述默认参数的正确语法。

因此，任何人都可以确认“添加 jsdoc 注释”插件是否遵循描述函数的正确语法。

检查下面的 invoiceUpdate 参数（这里我使用的是 TypeScript）。

  /**
   * @param  {string[]} invoiceIds
   * @param  {string} token
   * @param  {} invoiceUpdate=false
   * @returns Promise
   */
  public async calculateInvoices(
    invoiceIds: string[],
    token: string,
    invoiceUpdate = false,
  ): Promise<string> {
      
     /*
        function body
     */

  }

Answer 1

为了用默认值描述可选参数，根据the docs你应该使用这个语法：

/**
 * @param {string} [somebody=John Doe] - Somebody's name.
 */

那么，你的代码应该是这样的：

  /**
   * @param  {string[]} invoiceIds
   * @param  {string} token
   * @param  {boolean} [invoiceUpdate=false] invoiceUpdate
   * @returns Promise
   */
const calculateInvoices=(
    invoiceIds,
    token,
    invoiceUpdate = false,
  )=> {
      
     /*
        function body
     */

  }

  calculateInvoices(['sdf'],'sdf')

你也可以在最近更新的typescript JSDocs page

中找到很多信息

带有默认参数的函数的 JSDoc

JS Doc for functions with default parameters

visual-studio

jsdoc

typescript