microsoft / microsoft/TypeScript
Inherited methods not merging JSDoc comments
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit den Reproduktionen für TypeScript 5.9 und tsgo im Issue und lies anschließend microsoft/typescript-go#2111 zum verwandten Verhalten beim Zusammenführen von JSDoc. Vergleiche die Verarbeitung der Dokumentation geerbter Methoden, wobei die Vervollständigung bedeutet, dass der Text foo bar und der Block @remarks konsistent zusammengeführt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- go, typescript
- Bereich
- compilers
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100