CA1822: Marcar membros como estáticos

Causa

Um membro que não acessa dados de instância não está marcado como estático (Compartilhado no Visual Basic).

Descrição da regra

Os membros que não acessam dados de instância nem chamam métodos de instância podem ser indicados como estáticos (Shared no Visual Basic). Depois que você marcar os métodos como estáticos, o compilador emitirá sites de chamada não virtuais para esses membros. A emissão de sites de chamadas não virtuais impedirá uma verificação em tempo de execução para cada chamada, garantindo que o ponteiro do objeto atual não seja nulo. Isso pode levar a um ganho de desempenho mensurável para o código sensível ao desempenho. Em alguns casos, a falha em acessar a instância de objeto atual representa um problema de precisão.

Como corrigir violações

Marque o membro como estático (ou Compartilhado no Visual Basic) ou use 'this'/'Me' no corpo do método, se apropriado.

Example

public class Printer
{
    private readonly List<char> _items = [
        'H', 'e', 'l', 'l', 'o',
    ];

    public void PrintHello()
    {
        BadPrintHelloInternal();
        GoodPrintHelloInternal();
        GoodPrintHelloStaticInternal();
    }

    // This method violates the rule.
    private void BadPrintHelloInternal()
    {
        Console.WriteLine("Hello");
    }

    // This methods satisfies the rule.
    private void GoodPrintHelloInternal()
    {
        Console.WriteLine(string.Join(string.Empty, this._items));
    }

    private static void GoodPrintHelloStaticInternal()
    {
        Console.WriteLine("Hello");
    }
}

Quando suprimir avisos

É seguro suprimir um aviso dessa regra nos seguintes casos:

• Para o código enviado anteriormente para o qual a correção seria uma alteração significativa.
• Para métodos em classes que herdam de MarshalByRefObject. Os métodos nessas classes não devem ser marcados como estáticos, pois a infraestrutura de comunicação remota do .NET usa a expedição de instância para encaminhar chamadas entre os limites do AppDomain. Tornar esses métodos estáticos pode interromper a comunicação remota entre os limites do AppDomain.

Suprimir um aviso

Para suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem a fim de desabilitar e, em seguida, reabilitar a regra.

#pragma warning disable CA1822
// The code that's violating the rule is on this line.
#pragma warning restore CA1822

Para desabilitar a regra em um arquivo, uma pasta ou um projeto, defina a severidade como none no arquivo de configuração.

[*.{cs,vb}]
dotnet_diagnostic.CA1822.severity = none

Para obter mais informações, confira Como suprimir avisos de análise de código.

Configurar código para analisar

Use a opção a seguir para configurar em quais partes da base de código essa regra deve ser executada.

• Incluir superfícies de API específicas

Você pode configurar essa opção apenas para essa regra, para todas as regras às quais ela se aplica ou para todas as regras nessa categoria (Desempenho) às quais ela se aplica. Para saber mais, confira Opções de configuração de regra de qualidade de código.

Incluir superfícies de API específicas

Você pode configurar em quais partes da base de código executar essa regra, com base em sua acessibilidade, configurando a opção api_surface. Por exemplo, para especificar que a regra deverá ser executada apenas na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig no projeto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Regras relacionadas

• CA1812: Evitar classes internas não instanciadas