microsoft / microsoft/TypeScript
Add properties in JSDoc generation on destructuring in javascript file
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
Search Terms
JSDoc destructuring generate property javascript
Suggestion
When you use the JSDoc generation on function using destructuring, it could list the properties.
Use Cases
Avoid redundancy when writing code.
It could be useful for Javascript files and Typescript files.
Examples
Action:
Actual:
Expectation:
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript / JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. new expression-level syntax)
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, die JSDoc-Generierungsbeispiele im Issue für destrukturierte Funktionen in JavaScript und TypeScript zu reproduzieren. Verfolge den Einstiegspunkt der JSDoc-Generierung und die vorhandenen Tests. Überprüfe anschließend, dass die generierte Dokumentation destrukturierte Eigenschaften auflistet, ohne die Laufzeitausgabe von JavaScript zu verändern.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, typescript
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100