microsoft / microsoft/TypeScript
Allow reporting errors for unresolved @ link jsdoc tags
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
Suggestion
🔍 Search Terms
- jsdoc
@link
⭐ Suggestion
Add an option to report unresolved @link symbols in JSDoc comments.
This can help catch some simple mistakes and also alert the user to cases where our IntelliSense doesn't understand the jsdocs symbol
📃 Motivating Example
/**
* {@link food} <- Should been an error here
*/
const foo = 12
💻 Use Cases
We'd use this in vscode for both our main codebase and for our vscode.d.ts file.
I imagine this would also be quite useful for maintaining definitely typed
Related issues
- #15852
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 con l’esempio JSDoc motivante e il relativo issue #15852 per determinare come diagnosticare e rendere configurabili i simboli @link non risolti. Il lavoro è completo quando un’opzione segnala i link non risolti senza influire sui link validi, inclusi i casi d’uso descritti per VS Code e i file di dichiarazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100