jsdoc/tsdoc 在有多个重载方法时应该把注释写在哪个方法上?

发布于 2022-09-12 04:22:32 字数 366 浏览 16 评论 0

TypeScript 代码中,一个函数有多个重载,但仅打算写一个函数注释时,应该写在哪个方法上?

例如:

function merge<T, U>(x: T, y: T): T & U;
function merge<T, U, V>(x: T, y: U, z: V): T & U & V;
function merge(...args: any[]): any;

function merge(...args: any) {
    return ...
}

/**
 * Merge given objects.
 */

应该把这个注释放在哪个上面?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文