我使用 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
*/
}
Run Code Online (Sandbox Code Playgroud)