microsoft / microsoft/vscode-cpptools
Showing the documentation for virtual methods through inheritance.
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 6.2k
- Fork
- 1.7k
- Merge medio
- 14h 46m
- PR unite (30g)
- 61
Descrizione
Hello,
I usually document the interface like:
/**
* @breaf foo should do THE thing.
virtual void foo() = 0;
Documenting the override-ed method is often redundant so I don't do it much.
It would be nice if the hover would show the interface's documentation for the overridden method (if it is not provided for it of course).
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
Inizia individuando la gestione dell'hover di C++ e gli eventuali test per la documentazione dei metodi sovrascritti. Traccia il modo in cui viene selezionata la documentazione per una sovrascrittura e il relativo metodo virtuale di base. Il lavoro è completato quando un hover su una sovrascrittura non documentata mostra la documentazione dell'interfaccia ereditata, mentre la documentazione propria della sovrascrittura rimane prioritaria.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- cpp, typescript
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100