microsoft / microsoft/TypeScript

Inherited methods not merging JSDoc comments

Aperta
#63,789 6 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

## Steps to reproduce

```ts
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:
```ts
(method) Bar.method(): void
foo bar
@remarks — lorem ipsum
```

## Behavior with `tsgo`
Hovering over `Bar#method` gives:
```ts
(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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalle riproduzioni con TypeScript 5.9 e tsgo presenti nell'issue, quindi leggi microsoft/typescript-go#2111 per il comportamento correlato di fusione di JSDoc. Confronta la gestione della documentazione dei metodi ereditati, facendo sì che il completamento significhi che il testo `foo bar` e il blocco `@remarks` vengano uniti in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
go, typescript
Ambito
compilers
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.