如何在带键重映射的映射类型中继承属性注解？

AI 小北

2026-7-29

如何在TypeScript键重映射类型中继承原属性的JSDoc注解

默认情况下，你当前的Prefix映射类型只会复制原属性的类型，不会自动继承原属性的JSDoc注解。但可以通过以下方式实现需求：

方法1：继承原属性注解

使用/** @inheritDoc */标签显式引用原属性的JSDoc，修改映射类型如下：

type Prefix<Type, str extends string> = {
    [Property in keyof Type as `${str}${Capitalize<string & Property>}`]: 
    /** @inheritDoc Type[Property] */
    Type[Property]
};

interface Person {
    /** This is the name. */
    name: string;

    /** This is the age. */
    age: number;

    /** This is the location. */
    location: string;
}

interface A extends Prefix<Person, 'alpha'>, Prefix<Person, 'beta'> {};

此时在VS Code等支持TypeScript的编辑器中悬停A.alphaName，会显示：(property) A.alphaName: string. This is the name.，完全符合你的需求。

方法2：可选覆盖注解

如果需要在特定场景下覆盖原注解，可以给映射类型添加一个可选的覆盖参数：

type Prefix<Type, str extends string, Overrides extends Partial<Record<keyof Type, string>> = {}> = {
    [Property in keyof Type as `${str}${Capitalize<string & Property>}`]: 
    Overrides[Property] extends string 
        ? /** ${Overrides[Property]} */ Type[Property]
        : /** @inheritDoc Type[Property] */ Type[Property]
};

interface Person {
    /** This is the name. */
    name: string;

    /** This is the age. */
    age: number;

    /** This is the location. */
    location: string;
}

// 仅覆盖name的注解，其他属性保留原注解
interface A extends Prefix<Person, 'alpha', { name: 'This is the alpha-specific name.' }>, Prefix<Person, 'beta'> {};

这种写法下，A.alphaName会显示自定义的注解，而alphaAge、alphaLocation依然保留原Person中的注解。