microsoft / microsoft/TypeScript
JSDoc typed function comments inside functions
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 inside functions", "JSDoc comments inside", "typed function comments"
✅ Viability Checklist
- 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. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
Are we able add support for adding JSDoc typed function comments inside functions, either natively or by a setting?
📃 Motivating Example
Personally, I find it easier to read JSDoc typed function comments when they are indented nicely inside functions, similar to Python, which would also pair really well with code folding.
function arrayMove(index) {
/**
* @param {Number} index
* @return {Array}
*/
// ...
}
I enquired about this on Stackoverflow last year
💻 Use Cases
.
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
Im Issue sind keine Dateien, Tests oder Einstiegspunkte angegeben. Beginne damit, zu prüfen, wie TypeScript JSDoc-Kommentare innerhalb von Funktionskörpern behandelt, und bestimme das beabsichtigte Verhalten für das motivierende Beispiel; done sollte bedeuten, dass eingerückte JSDoc-Typisierung unterstützt wird, ohne die JavaScript-Laufzeitausgabe zu ä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
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100