microsoft / microsoft/TypeScript

Implemented method JSDocs not behaving correctly for @param

Aperta
#38,643 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Bug Domain: JSDoc
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Riproduci l’esempio dell’interfaccia e della classe che la implementa, quindi esamina il percorso completionEntryDetails usato da IntelliSense per il metodo della classe. Confronta la documentazione dei parametri mostrata per l’interfaccia con quella mostrata per l’implementazione. Il lavoro è completato quando i completamenti dell’implementazione includono le descrizioni @param dell’interfaccia, con copertura per l’esempio segnalato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
compilers
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.