![](/img/trans.png)
[英]How to type function parameters in TypeScript to map object properties?
[英]How to describe object properties parameters for a function in typescript TSDoc?
如何在 TSDoc 中添加a
和b
的描述? 我希望当我 hover 在 function 调用中的属性参数上显示描述fn({ a })
。
// This does not work
/**
* @param props
* @param props.a docs for a
* @param props.b docs for b
*/
function fn({a, b}: {a: string, b: string}) {}
fn({ a })
// ~
// Expecting hover info for `a`.
这确实有效
interface Params {
/** Desc for a */
a?:string;
b?:string;
}
/**
* Desc for fn
*/
function fn({a, b}: Params) {}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.