microsoft / microsoft/TypeScript

Inherited methods not merging JSDoc comments

Ouverte
#63,789 6 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

Steps to reproduce

class Foo {
   /** foo bar */
   method(): void {}
}

class Bar extends Foo {
   /** @remarks lorem ipsum */
   method(): void {}
}

Behavior with typescript@5.9

Hovering over Bar#method gives:

(method) Bar.method(): void
foo bar
@remarks — lorem ipsum

Behavior with tsgo

Hovering over Bar#method gives:

(method) Bar.method(): void
@remarks — lorem ipsum

Note that the foo bar is gone. I believe that blocks like @remarks being merged is a case not handled by microsoft/typescript-go#2111

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 les reproductions avec TypeScript 5.9 et tsgo présentes dans l’issue, puis consultez microsoft/typescript-go#2111 pour le comportement associé de fusion de JSDoc. Comparez la gestion de la documentation des méthodes héritées, la complétion devant signifier que le texte foo bar et le bloc @remarks sont fusionnés de manière cohérente.

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

Évaluation

Stack technique
go, typescript
Domaine
compilers
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
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.