Skip to content

Commit a8d6b6a

Browse files
committed
Added xml comment
1 parent a5895cf commit a8d6b6a

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/Files.App/Helpers/NaturalStringComparer.cs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,15 @@ public static IComparer<object> GetForProcessor()
99
{
1010
return new NaturalComparer(StringComparison.CurrentCulture);
1111
}
12-
12+
13+
/// <summary>
14+
/// Provides functionality to compare and sort strings in a natural (human-readable) order.
15+
/// </summary>
16+
/// <remarks>
17+
/// This class implements string comparison that respects the natural numeric order in strings,
18+
/// such as "file10" being ordered after "file2".
19+
/// It is designed to handle cases where alphanumeric sorting is required.
20+
/// </remarks>
1321
private sealed class NaturalComparer : IComparer<object?>, IComparer<string?>, IComparer<ReadOnlyMemory<char>>
1422
{
1523
private readonly StringComparison stringComparison;

0 commit comments

Comments
 (0)