如何为扩展接口的泛型函数参数制作TypeScript tsdoc文档？
如何为扩展接口的泛型函数参数制作TypeScript tsdoc文档？
提问于 2021-10-15 15:44:17
考虑以下代码，请注意someField的文档
interface Test {
/**
* Some description.
* lorum ipsum.
* foo bar.
*/
someField: string;
}
function withGeneric<T extends Test>(arg: T) {
return arg;
}
function withoutGeneric(arg: Test) {
return arg;
}
withGeneric({
someField: ""
});
withoutGeneric({
someField: ""
});当我将鼠标悬停在withoutGeneric调用中的someField上时，VSCode很好地向我显示了文档：
但是，当将鼠标悬停在withGeneric调用中的someField上时，不会显示文档：
有没有办法让tsdoc文档也能使用泛型参数？
Stack Overflow用户
发布于 2021-10-18 08:00:55
我找到了一个适合我的答案。添加具有extended from类型的联合：
/**
* withGeneric sample
* @typeParam T - must be a Test
* @param arg
* @returns
*/
function withGeneric<T extends Test>(arg: T & Test) {
return arg;
}现在，VSCode确实显示了文档：
这感觉像是一场恶作剧，但我看不出它有什么缺点？
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/69587324
复制相关文章
相似问题
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号