inherit interface/type block comment

[Tzxhy]

🔍 Search Terms

comment inherit

✅ Viability Checklist

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
• This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
• This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

⭐ Suggestion

Add more block comment mechanism.

📃 Motivating Example

export enum TreeNodeExpanderStatus {
    /** full expanded */
    FullExpanded,
    /** full collapsed */
    FullCollapsed,
    /** partial expanded */
    PartialExpanded,
}
interface Props {
    

    status: TreeNodeExpanderStatus
    /** callback when click expand icon */
    onClickExpand(): void;
    /** callback when click collapse icon */
    onClickCollapse(): void;
}

When i use IDE to see Props.status, shows:

But if it can show the TreeNodeExpanderStatus comment, it will better. Right? Like this:

Also, this should work when no other comments upper on property status.

💻 Use Cases

1. What do you want to use this for?

2. What shortcomings exist with current approaches?

3. What workarounds are you using in the meantime?

4. Write less comments.

5. No appropriate comments inheritance mechanism.

6. Write more comments.

[RyanCavanaugh]

This gets very confusing because you don't know whether the comment is referring to the type or the property.

It's also very noisy because it means comments for commonly-used types (RegEx, etc) show up everywhere which is very rarely useful

[typescript-bot]

This issue has been marked as "Declined" and has seen no recent activity. It has been automatically closed for house-keeping purposes.