Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / C#

C# — `#nullable enable`, `string?` y `[NotNullWhen(true)]` para dos parámetros `out`

Activa el análisis de nulabilidad y describe las dos salidas de un método `Try*` para que el compilador sepa que ninguna vale `null` cuando la operación tiene éxito.

Versión: C# 12 and .NET 8; later runtimes may add compatible features

Sintaxis

#nullable enable
using System.Diagnostics.CodeAnalysis;

static bool TryGetLabels(
    string key,
    [NotNullWhen(true)] out string? primary,
    [NotNullWhen(true)] out string? secondary)

En C# 12 sobre .NET 8, #nullable enable activa las anotaciones de nulabilidad y sus advertencias en las líneas siguientes, hasta que otra directiva cambie el contexto o termine el archivo. string? admite null; string declara una referencia que no debería ser null. Ambos tienen el mismo tipo en tiempo de ejecución y la anotación no añade ninguna comprobación en ese momento.

[NotNullWhen(true)] es la forma abreviada del atributo NotNullWhenAttribute de System.Diagnostics.CodeAnalysis. En un parámetro out string?, indica que, si el método devuelve true, esa salida concreta no es null. La garantía solo se aplica al parámetro anotado, de modo que TryGetLabels anota primary y secondary por separado.

El método debe asignar un valor a ambos parámetros out antes de cada retorno normal. Para "menu", esta implementación proporciona "Open" y "Close" y devuelve true. Para otra clave, asigna null a ambos y devuelve false. Es una decisión de la implementación: el atributo no exige que ninguna de las dos salidas sea null cuando el valor devuelto es false.

En la rama if, el compilador considera que ninguna referencia es nula, así que puedes leer ambas propiedades Length sin !. En else, considera que cualquiera de las dos puede ser nula; ?? proporciona texto alternativo. El atributo no hace cumplir el contrato en tiempo de ejecución. En cambio, [MaybeNull] permite una salida posiblemente nula a pesar de una declaración no anulable, mientras que [MemberNotNull] describe el estado de los campos o propiedades indicados al volver de un método, no el de los parámetros out.

Ejemplos

#nullable enable
using System;
using System.Diagnostics.CodeAnalysis;

foreach (string key in new[] { "menu", "other" })
{
    if (TryGetLabels(key, out string? primary, out string? secondary))
    {
        Console.WriteLine($"{primary.Length}, {secondary.Length}");
    }
    else
    {
        Console.WriteLine($"{primary ?? "<null>"}, {secondary ?? "<null>"}");
    }
}

static bool TryGetLabels(
    string key,
    [NotNullWhen(true)] out string? primary,
    [NotNullWhen(true)] out string? secondary)
{
    if (key == "menu")
    {
        primary = "Open";
        secondary = "Close";
        return true;
    }

    primary = null;
    secondary = null;
    return false;
}

Resultado

4, 5
<null>, <null>

La primera línea contiene las longitudes de las dos etiquetas; la segunda muestra los dos marcadores de `null`. Quita el atributo solo de `secondary` y vuelve a compilar: se espera CS8602 en `secondary.Length`, pero no en `primary.Length`.

Lecciones relacionadas

  • C# · Lección 53 · Avanzado · Versión: 3

Fuentes