microsoft / microsoft/TypeScript

Show inherited comments in quick info

Open
#9,266 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: API Domain: LS: Quick Info Experience Enhancement In Discussion Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

TypeScript Version: 1.8.10

Have an interface in one file

interface IFooController {
    /**
     * random comment
     * @returns {string} Returns a string
     */
    test(): string;
}

export default IFooController;

In another file have a class that implements that interface


import IFooController from "../Interfaces/Controllers/IFooController";

export default class FooController implements IFooController {
    test(){

    }
}

Expected behavior:

See the comments of the interface when hover over the class method

Actual behavior:

See nothing.

This doesn't happen with functions and class comments.
This only happens when interface is imported.

Using Microsoft Visual Studio Professional 2015
Version 14.0.25123.00 Update 2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the example using Interfaces/Controllers/IFooController and FooController, then start by tracing the TypeScript quick-info behavior for a method implementing an imported interface. Done means hovering over FooController.test shows the interface comment and @returns text, matching the expected behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.