microsoft / microsoft/TypeScript

Implemented method JSDocs not behaving correctly for @param

Ouverte
#38,643 1 commentaire 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Bug Domain: JSDoc
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Reproduisez l’exemple de l’interface et de la classe qui l’implémente, puis examinez le chemin completionEntryDetails utilisé par IntelliSense pour la méthode de la classe. Comparez la documentation des paramètres affichée pour l’interface avec celle affichée pour l’implémentation. Le travail est terminé lorsque les complétions de l’implémentation incluent les descriptions @param de l’interface, avec une couverture de l’exemple signalé.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
compilers
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.