microsoft / microsoft/TypeScript
JSDoc - generate @type for a variable
Offen
Dieses Issue hat noch niemand übernommen.
Awaiting More Feedback
Domain: JavaScript
Domain: JSDoc
Suggestion
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
From @egamma on February 22, 2017 11:21
Generating a JSDoc comment for a variable/constant should generate an @type annotation
/** |
var p;
Inserts
/**
* @type {any}
*/
var p;
Copied from original issue: Microsoft/vscode#21110
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 damit, den im Issue beschriebenen JSDoc-Generierungsablauf für Variablen/Konstanten anhand des bereitgestellten JavaScript-Beispiels zu reproduzieren. Fertig ist es, wenn der generierte Kommentar vor der Variablendeklaration eine @type {any}-Annotation enthält, die der gezeigten Ausgabe entspricht.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- developer-experience, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100