oliverbooth/X10D
oliverbooth/X10D
1
0
Fork 0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-10 03:05:42 +00:00
Code Issues

(#15) Improve xmldoc for string.AsNullIfEmpty/WhiteSpace

Browse Source
This commit is contained in:
Oliver Booth 2022-03-06 17:27:31 +00:00
parent 1d74f7f896
commit b2cf22efdf
No known key found for this signature in database
GPG Key ID: 32A00B35503AF634
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
X10D/src/StringExtensions/StringExtensions.cs
View File

@ -1,3 +1,4 @@
using System.Diagnostics.CodeAnalysis;
using System.Text;
namespace X10D;
@ -8,27 +9,29 @@ namespace X10D;
public static class StringExtensions
{
/// <summary>
/// Returns the current string, or <see langword="null" /> if the current string is null or empty.
/// Normalizes a string which may be either <see langword="null" /> or empty to <see langword="null" />.
/// </summary>
/// <param name="value">The value to sanitize.</param>
/// <param name="value">The value to normalize.</param>
/// <returns>
/// <see langword="null" /> if <paramref name="value" /> is <see langword="null" /> or equal to
/// <see cref="string.Empty" />, or <paramref name="value" /> otherwise.
/// <see langword="null" /> if <paramref name="value" /> is <see langword="null" /> or empty; otherwise,
/// <paramref name="value" />.
/// </returns>
[return: NotNullIfNotNull("value")]
public static string? AsNullIfEmpty(this string? value)
{
return string.IsNullOrEmpty(value) ? null : value;
}
/// <summary>
/// Returns the current string, or <see langword="null" /> if the current string is null, empty, or consists of only
/// whitespace.
/// Normalizes a string which may be either <see langword="null" />, empty, or consisting of only whitespace, to
/// <see langword="null" />.
/// </summary>
/// <param name="value">The value to sanitize.</param>
/// <param name="value">The value to normalize.</param>
/// <returns>
/// <see langword="null" /> if <paramref name="value" /> is <see langword="null" /> or equal to
/// <see cref="string.Empty" /> or is composed of only whitespace characters, or <paramref name="value" /> otherwise.
/// <see langword="null" /> if <paramref name="value" /> is <see langword="null" />, empty, or consists of only
/// whitespace; otherwise, <paramref name="value" />.
/// </returns>
[return: NotNullIfNotNull("value")]
public static string? AsNullIfWhiteSpace(this string? value)
{
return string.IsNullOrWhiteSpace(value) ? null : value;