dotnet / dotnet/dotnet-api-docs

Missing Regex Class Orientation Material

Aperta
#11,614 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub
:watch: Not Triaged area-System.Text.RegularExpressions untriaged
Lingua principale
C#
Stelle
949
Fork
1.7k
Merge medio
2g 19h
PR unite (30g)
52

Descrizione

_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)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla pagina della documentazione della classe System.Text.RegularExpressions.Regex e rivedine il contenuto introduttivo, in particolare la relazione tra Groups e Captures. Aggiungi una breve introduzione che spieghi i modi previsti per usare Regex e dove i lettori devono cercare i risultati delle corrispondenze, quindi verifica che la pagina renderizzata sia chiara prima del materiale dettagliato dell’API.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.