microsoft / microsoft/TypeScript
Implemented method JSDocs not behaving correctly for @param
Open
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:
- 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;
- Attempt to access intellisense for the class, and notice the @param information has not been picked up from the interface.

Does this issue occur when all extensions are disabled?: Yes
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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