JSDoc用于复用功能接口

问题描述 投票:2回答:1

我正在连接到多个电子邮件工具,并将其API抽象为一个通用的sendEmail函数,每个服务具有相同的params和相同的returns。这意味着对于每个电子邮件服务(Mailchimp,Sen​​dGrid ...),我必须编写一个具有相同JSDoc的函数,该函数描述相同的@params和相同的@returns ...

是否有有效的JSDoc语法可用于@typedef或类似的功能,而不是在每个函数上方声明@params@returns,只需描述类型?

...未禁用ESLint的require-jsdoc的奖励积分>

我正在连接到多个电子邮件工具,并将其API抽象为一个通用的sendEmail函数,每个服务具有相同的参数和相同的返回值。这意味着对于每个电子邮件服务(...

javascript typescript typescript-typings jsdoc jsdoc3
1个回答
2
投票

有一种定义它的方法。使用require-jsdoc等效于@callback进行功能。

© www.soinside.com 2019 - 2024. All rights reserved.