microsoft / microsoft/TypeScript
Intellisense behaviour of functions and parameters
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
Some odd/unintuitive Intellisense behaviour:
/**
* Function description A
* @param name Parameter description A
*/
function uniqueName(name: string): string {
}
export const Uid = {
/**
* Function description B
* @param name Parameter description B
*/
uniqueName
};
The intellisense description for the 'Uid.uniqueName' property is now description B, however the intellisense for the parameter is description A. There isn't anything overriding here - the description of the function is always taken from the export, and the parameter description is always taken from the function definition. As such, I need to do the following to get full intellisense support for this pattern:
/**
* @param name Parameter description
*/
function uniqueName(name: string): string {
}
export const Uid = {
/**
* Function description
*/
uniqueName
};
i.e. function definitions in one place, parameter definitions in another place. I know I can work around this by restructuring the code, but it still feels like I should be able to achieve it in the above format.
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
Non viene indicato alcun file sorgente né alcun test. Riproduci gli esempi di TypeScript IntelliSense nell’issue e traccia il modo in cui vengono selezionate la documentazione della proprietà esportata e quella del parametro della funzione; il lavoro è completato quando sia la descrizione documentata della funzione sia la descrizione del parametro provengono dalle dichiarazioni previste, senza ristrutturare il codice.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- 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
- 25/100