microsoft / microsoft/TypeScript

Implemented method JSDocs not behaving correctly for @param

Open
#38,643 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Domain: JSDoc
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

TS Template added by @mjbvz

TypeScript Version: 4.0.0-dev.20200518

Search Terms

  • completionEntryDetails
  • jsdoc
  • tags

  • VSCode Version: 1.45.0
  • OS Version: Ubuntu 20.04

Steps to Reproduce:

  1. Add JSDocs to an interface, and implement that interface in a class
interface Sample {
  /** 
   * Does some important work
   * @param name Name of employee working
   * @param age Age of employee
   */
  doWork(name: string, age: number): void;
}

let s: Sample;


class Concrete implements Sample {
  doWork(name: string, age: number) {
    // Nothing to do
  }
}

let c: Concrete;
  1. Attempt to access intellisense for the class, and notice the @param information has not been picked up from the interface.

travetto-1589679889262

Does this issue occur when all extensions are disabled?: Yes

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 interface and implementing class example, then inspect the completionEntryDetails path used by IntelliSense for the class method. Compare the parameter documentation shown for the interface with that shown for the implementation. Done means the implementation's completions include the interface's @param descriptions, with coverage for the reported example.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.