dotnet / dotnet/dotnet-api-docs

Missing Regex Class Orientation Material

Offen
#11,614 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
:watch: Not Triaged area-System.Text.RegularExpressions untriaged
Vorherrschende Sprache
C#
Sterne
949
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

_This issue has been moved from [a ticket on Developer Community](https://developercommunity.visualstudio.com/t/Missing-Regex-Class-Orientation-Material/10723811)._

---
[severity:It's more difficult to complete my work]
System.Text.RegularExpressions.Regex is a HUGELY important class. But there is ZERO orientation material on this web page to give the programmer/reader an overview of how it works, and different ways the designer intended it to be used, so the reader knows whether he should be doing it "one way" and looking for Captures or another way and looking for Groups.... And the orientation material SHOULD be on the page where the top level of the Regex Class is documented, and it should be the first paragraph under the title.... This kind of documentation is largely missing from a great deal of the .NET documentation. I'm surprised -- after all these years -- that it is _still_ missing....

The consequences of this is that the reader has to (painfully) study ALL the details (which takes a long time) to figure out how the designer(s) intended it to be used.... When this could be solved in a small number of paragraphs, probably less than 4. (I'm a technical writer -- trust me when I say this documentation really _needs_ that orientation material.) It makes the difference in the reader being able to competently use the Regex class in 5 minutes, vs 2+ hours....

Kind regards,
Victor Wheeler

---
### Original Comments

#### Feedback Bot on 8/16/2024, 03:15 AM:

(private comment, text removed)

---
### Original Solutions
(no solutions)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie auf der Dokumentationsseite der Klasse System.Text.RegularExpressions.Regex und überprüfen Sie deren einleitenden Inhalt, insbesondere die Beziehung zwischen Groups und Captures. Fügen Sie eine kurze Orientierung hinzu, die die vorgesehenen Verwendungsmöglichkeiten von Regex erläutert und angibt, wo Leser nach Match-Ergebnissen suchen sollten, und überprüfen Sie anschließend, ob die gerenderte Seite vor dem detaillierten API-Material klar verständlich ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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