Allow reporting errors for unresolved @ link jsdoc tags

Ouverte
#44,200 0 commentaires 4 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

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

Piste de recherche

Commencez par l’exemple JSDoc à l’origine de la demande et l’issue associée #15852 afin de déterminer comment les symboles @link non résolus doivent être signalés et rendus configurables. Le travail est terminé lorsqu’une option signale les liens non résolus sans affecter les liens valides, y compris les cas d’utilisation décrits pour VS Code et les fichiers de déclaration.

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

Description

In Discussion Suggestion

Suggestion

🔍 Search Terms

  • jsdoc
  • @link

⭐ Suggestion

Add an option to report unresolved @link symbols in JSDoc comments.

This can help catch some simple mistakes and also alert the user to cases where our IntelliSense doesn't understand the jsdocs symbol

📃 Motivating Example

/**
 * {@link food} <- Should been an error here
 */
const foo = 12

💻 Use Cases

We'd use this in vscode for both our main codebase and for our vscode.d.ts file.

I imagine this would also be quite useful for maintaining definitely typed

Related issues

  • #15852
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

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.

Autres issues de microsoft/TypeScript

Toutes les issues de microsoft/TypeScript

Issues similaires

Plus d'issues Go

Recevez les nouvelles issues par e-mail

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