reactjs / reactjs/react-docgen

Why not realize "//" which can also be a description?

Offen
#420 1 Kommentar 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
3.8k
Forks
316
Ø Merge
5 Std. 7 Min.
Gemergte PRs (30 T.)
4

Beschreibung

"
/**
*
*/
"
this can be regarded as a description. How about "//" ?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Die Aufgabe fragt, ob //-Kommentare neben der gezeigten Blockkommentarform ebenfalls als Beschreibungen behandelt werden sollten. Finde den Einstiegspunkt für das Parsen von Kommentaren und die vorhandene Abdeckung von Beschreibungen, und betrachte die Arbeit als abgeschlossen, wenn der vorgesehene Text aus //-Kommentaren extrahiert wird, ohne die Verarbeitung von Blockkommentaren zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.