microsoft / microsoft/TypeScript

JSDoc @param does not work for function variables

Ouverte
#36,633 2 commentaires 2 réactions 1 personne assignée Voir sur GitHub

@minestarks y travaille déjà.

Depuis le 2/3/2020.

Needs Investigation
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

TypeScript Version: 3.5.1, 3.7.5

Search Terms: jsdoc, param, variable, function

Code

function makeFoo() {
    return (x : number) => {}
}

/**
 * @param x - Comment
 */
const foo = makeFoo();
foo(/* No comment in hover */);

/**
 * @param x - Comment
 */
function foo2(x: number) {
    
}
foo2(/* Comment in hover */)

Expected behavior:
image

Actual behavior:
image

Playground Link: Playground

Related Issues: Couldn't find any


For my use case, I use factories to make functions a lot.

export const lPad = makeOperator3<string, bigint, string, string>(/*args*/);
export const rPad = makeOperator3<string, bigint, string, string>(/*args*/);
export const lTrim = makeOperator1<string, string>(/*args*/);
export const rTrim = makeOperator1<string, string>(/*args*/);

And I'd like to add JSDoc to these variables, because the parameter names aren't very descriptive, by themselves (left, mid, right, arg, etc.). But it seems like the JSDoc for @param does not show up in hover on VS Code and the Playground.

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.

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

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