microsoft / microsoft/TypeScript
JSDoc tooltip for function type
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.4k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
Suggestion
🔍 Search Terms
JSDoc tooltip for function type
✅ Viability Checklist
My suggestion meets these guidelines: Yes.
⭐ Suggestion
Show JSDoc tooltip for function type.
📃 Motivating Example
interface F {
/**
* Documentation.
*/
(): void;
}
const f: F;
// In Visual Studio Code I see JSDoc tooltip on mouse hover when I use interface.
f();
/**
* Documentation.
*/
type G = () => void;
const g: G;
// No JSDoc tooltip for function type.
g();
💻 Use Cases
This should improve working experience when using editors like Visual Studio Code.
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 tracciando le informazioni hover del servizio linguistico TypeScript utilizzate per la firma di chiamata dell’interfaccia e per l’alias del tipo funzione mostrato nell’esempio motivante. Riproduci entrambi i casi in Visual Studio Code e confronta i tooltip restituiti; il lavoro è completato quando il tipo funzione riceve il proprio tooltip JSDoc come richiesto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript, vscode
- Ambito
- developer-experience, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100