microsoft / microsoft/TypeScript

JSDoc multi-line properties within Array<Object> syntax parse differently than Object[]

Ouverte
#30,965 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Bug Domain: JSDoc
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

TypeScript Version: 3.5.0-dev.20190416

Search Terms:
JSDoc @type @param @arg multi-line type literal Array<>

Code

/**
 * @param {Array<Object>} os - has a string and a number
 * @param {string} os[].s - the string
 * @param {number} os[].n - the number
 */
function f(os) { return os[0].s; }

Expected behavior:

It appears that #17352 implemented this correctly for when the first @param is @param {Object[]} but failed to consider the other syntax to write this in JSDoc: @param {Array<Object>}.

For ease of debugging I am looking at the output of Intellisense when hovering over os in the function. I'd expect the output to look as iti does when @param {Object[]} is used:
image

Actual behavior:
image

Playground Link:
Playground Link

Related Issues:
#11597

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

Commencez par la reproduction liée dans Playground et comparez les informations affichées au survol de Array<Object> avec la syntaxe équivalente Object[]. Lisez le comportement décrit dans #17352 et comparez l’issue associée #11597 ; c’est terminé lorsque les deux formes produisent les mêmes informations de propriétés sur plusieurs lignes pour os.

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

Évaluation

Stack technique
javascript, 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
38/100

Recevez les nouvelles issues par e-mail

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