microsoft / microsoft/TypeScript
Adding jsdoc to overriding method makes inherited jsdoc disappear
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
When adding doc to a class for API level, if we add more doc inside the implementation, we lost some documentation !
ex here, i add * @example $AA.method() and if i add tag @implement or any others in the childClass, we lost documentations from parent and for the API level.
This image show tag:@example $AA.method() is removed!, because we add more doc in AA.method !

The expected behavior should be look like this (push docs and no replace) .
Work only if we add in parent , but should work if we add in child class.

- VS Code Version:
Version : 1.55.0 (user setup)
Commit : c185983a683d14c396952dd432459097bc7f757f
Date : 2021-03-30T16:01:55.261Z
Electron : 11.3.0
Chrome : 87.0.4280.141
Node.js : 12.18.3
V8 : 8.7.220.31-electron.0
OS : Windows_NT x64 10.0.19042
Steps to Reproduce:
Add doc to AA.method will remove some docs in the A.method
abstract class A {
/** `method` to be implement for the class AA
* @example $AA.method()
*/
abstract method(): any;
}
class AA extends A {
/**
* @implements more info on the implementation
*/
method() {
throw new Error('Method not implemented.');
}
}
Does this issue occur when all extensions are disabled?: Yes
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Riproduci l’esempio astratto A/AA in VS Code con le estensioni disabilitate e confronta la documentazione renderizzata per il metodo ereditato. Traccia la gestione di JSDoc sui metodi sovrascritti da parte di TypeScript language-service, quindi aggiungi o aggiorna un test di regressione se viene individuata l’area di test pertinente. Il lavoro è completato quando viene aggiunta la documentazione dell’implementazione senza rimuovere gli esempi ereditati o il testo a livello di API.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers, tooling
- Tipo di issue
- Bug
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100