dotnet / dotnet/dotnet-api-docs

Documentation missing

Offen Anfängerfreundlich
#1,055 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area-System.Runtime dotnet-api/prod Pri2 untriaged
Vorherrschende Sprache
C#
Sterne
949
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

The overloaded method `public int GetHashCode(StringComparison comparisonType)` is not documented. Its is only mentioned it here and there is no guidance when it should be used. The source file says:

> Gets a hash code for this string and this comparison. If strings A and B and comparison C are such that string.Equals(A, B, C), then they will return the same hash code with this comparison C.

See: https://github.com/dotnet/coreclr/blob/master/src/System.Private.CoreLib/shared/System/String.Comparison.cs.

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: 46e1d9ef-f477-c47a-da4e-88feb95f6dc9
* Version Independent ID: acedf195-f641-b347-39a9-7b3a43d32e00
* Content: [String.GetHashCode Method (System)](https://docs.microsoft.com/en-us/dotnet/api/system.string.gethashcode?view=netcore-2.1#System_String_GetHashCode_System_StringComparison_)
* Content Source: [xml/System/String.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System/String.xml)
* Product: **dotnet-api**
* GitHub Login: @dotnet-bot
* Microsoft Alias: **dotnetcontent**

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Öffne xml/System/String.xml und suche den Eintrag String.GetHashCode(StringComparison). Vergleiche ihn anschließend mit der entsprechenden Quelle in System.Private.CoreLib/shared/System/String.Comparison.cs. Aktualisiere die API-Dokumentation mit Hinweisen dazu, wann diese Überladung verwendet werden sollte, und überprüfe, dass die gerenderte Referenzseite zu String.GetHashCode die neue Erklärung enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
72/100

Neue Issues direkt in Ihr Postfach

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