typescript - 具有默认参数的函数的 JS Doc
问题描述
我使用 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
*/
}
解决方案
为了用默认值描述可选参数,根据文档,您应该使用以下语法:
/**
* @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')
推荐阅读
- sharepoint - 如何使用 UiPath 中的 CAML 查询更新 Sharepoint 项目的列值?
- eclipse - 在 ABAP 存储库中没有提交和检索 SAP UI5 应用程序的选项
- c++ - 循环条件适用于原始迭代器,但不适用于迭代器解引用
- spring - Spring Boot Rest 控制器不接受多部分表单数据
- javascript - 确定浏览器的屏幕宽度是多少
- javascript - jsp - javascript - 单击事件对于循环 id 元素以更新数据库中的记录
- sql - 如何递归地从实体框架中的父/子获取 id?
- javascript - Vuejs 使用 postmessage 从 iframe 接收事件
- multithreading - 线程被台面信号量唤醒后如何获取锁?
- wpf - 为什么 DisplayMemberPath 没有显示?