microsoft / microsoft/TypeScript
Feature Request: Split out JsDoc comments for constructor function when convert function to ES2015 class
Offen
Dieses Issue hat noch niemand übernommen.
Awaiting More Feedback
Domain: LS: Refactorings
Suggestion
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
Add ability to convert JsDoc comments in following situation:
/**
* @class
* Some constructor description.
* @classdesc
* Some class description
*/
function Class() {}
must be converted to
/**
* Some class description
*/
class Class {
/**
* Some constructor description.
*/
constructor() {}
}
Right now you get following result:
/**
* @class
* Some constructor description.
* @classdesc
* Some class description
*/
class Class {
constructor() {}
}
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
Es wird keine Datei, kein Test und kein Einstiegspunkt genannt. Beginne damit, die Umwandlung von Funktionen in ES2015-Klassen und deren JsDoc-Verarbeitung zu finden; abgeschlossen ist die Aufgabe, wenn @classdesc zum Klassenkommentar wird, während die Konstruktorbeschreibung zum Konstruktor-Kommentar wird, wie in den Beispielen gezeigt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, typescript
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100