microsoft / microsoft/TypeScript
Report errors (and quickfixes) for incorrect JSDoc
Offen
Dieses Issue hat noch niemand übernommen.
Domain: JSDoc
In Discussion
Suggestion
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
TypeScript Version: nightly (2.4.0-dev.20170515)
Code
/**
* @param abcdeg A parameter
*/
function f(abcdefg: number) {
abcdeg;
}
Expected behavior:
Can fix spelling for either abcdeg.
Actual behavior:
Does not work in jsdoc.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der TypeScript/JSDoc-Verarbeitung für das bereitgestellte Funktionsbeispiel und verfolge, wie falsch geschriebene @param-Namen und Referenzen derzeit verarbeitet werden. Ermittle, wo Diagnosen und Quickfixes für diese Abweichungen erzeugt werden. Als erledigt gilt die Aufgabe, wenn das Beispiel den Rechtschreibfehler meldet und für jedes der beiden Vorkommen eine Korrektur anbietet und entsprechende Tests für beide Fälle hinzugefügt wurden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100