microsoft / microsoft/TypeScript
Inline JSDoc tags don't work in comments that start with plain text
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
TS mostly supports inline tags, even though they're not standard, but the implementation is quirky since it's best-effort, not really a committed feature. Specifically, an inline tag works if the line starts with a non-inline tag, or is a line following such a line:
/** @param foo @see foo.bar */
or
/** @param foo - a long description
* also @see foo.bar */
This is all down to the state machine we use for parsing, so it could be improved to also support
/** for more info @see foo.bar */
Based on discussion in #5802
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 la macchina a stati per l’analisi JSDoc descritta nell’issue e confronta la gestione delle righe che iniziano con testo semplice rispetto a quelle che iniziano con tag non inline. Il lavoro è completato quando i tag inline come @see vengono riconosciuti nell’esempio di testo semplice e gli esempi esistenti continuano a funzionare; il payload non indica file o test specifici.
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
- Specificata chiaramente
- Idoneità per principianti
- 38/100