microsoft / microsoft/TypeScript-TmLanguage

JSDoc grammar highlights @return {@link ...} as type

Ouverte
#877 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
TypeScript
Étoiles
471
Forks
149
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

With the following code, TS claims that {@link TreeItem} is incorrect

export interface TreeDataProvider<T> {
/**
 * @return {@link TreeItem} representation of the element
*/
 getTreeItem(element: T): TreeItem;
}

adding a character between return and {@link TreeItem} resolves it.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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 le traitement incorrect avec l’exemple JSDoc de l’issue, puis examinez les règles de grammaire TextMate de TypeScript qui couvrent les balises @return et {@link ...} inline. C’est terminé lorsque le lien n’est plus traité comme un type invalide ni surligné incorrectement, tandis que les types @return ordinaires continuent de fonctionner.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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