Skip to content

Hover documentation for typescript uses jsdoc rules and not tsdoc #61603

Description

@SirzBenjie
  • VS Code Version: 1.99.3
    17baf841131aa23349f217ca7c570c76ee87b957
    x64
  • OS Version: N/A (happens on all)

Steps to Reproduce:

  1. Write some typescript code and use the syntax required by tsdoc
  2. Observe that hover documentation and highlighting completely ignore tsdoc and instead assume parity with jsdoc
  3. Cry in pain as you realize that despite being written in typescript, VSCode has shoddy typescript support

Examples:

Thinking that the mandatory hyphen after a parameter name is a markdown hint for a bullet point
Image

Not recognizing the @defaultValue tag, and assuming @default and @defaultvalue

Image

Not understanding @remarks, which is marked as core, meaning you are expected to recognize it

Not providing hover for @typeParam
 Image

(The list goes on...)

Also, this last remark isn't a bug, but it would be really, really great if you would support @inheritDoc for hover.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featureSuggestionAn idea for TypeScript

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions