CA1822: Marcar membros como estáticos

Motivo

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

Descrição da regra

Os membros que não accedem a dados de instância ou não chamam métodos de instância podem ser marcados como estáticos (Partilhado no Visual Basic). Depois de marcar os métodos como estáticos, o compilador emitirá sites de chamada não virtuais para esses membros. A emissão de locais de chamada não virtuais evitará a necessidade de uma verificação em tempo de execução para cada chamada, assegurando que o ponteiro do objeto atual não seja nulo. Isso pode obter um ganho de desempenho mensurável para código sensível ao desempenho. Em alguns casos, a falha ao acessar a instância do objeto atual representa um problema de correçã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 desta regra nos seguintes casos:

• Para código anteriormente enviado cuja correção seria uma mudança que quebra a compatibilidade.
• Para métodos em classes que derivam de MarshalByRefObject. Os métodos nestas classes não devem ser marcados como estáticos, porque a infraestrutura remota .NET utiliza o despacho de instâncias para encaminhar chamadas através dos limites do AppDomain. Tornar tais métodos estáticos pode quebrar o processo de remoting através dos limites do AppDomain.

Suprimir um aviso

Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar 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 de um arquivo, pasta ou projeto, defina sua gravidade como none no arquivo de configuração.

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

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

Configurar código para análise

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

• Incluir superfícies de API específicas

Você pode configurar essa opção apenas para esta regra, para todas as regras às quais ela se aplica ou para todas as regras nesta categoria (Desempenho) às quais ela se aplica. Para obter mais informações, consulte Opções de configuração da 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, definindo a opção api_surface. Por exemplo, para especificar que a regra deve ser executada somente na superfície de API não pública, adicione o seguinte par chave-valor a um arquivo .editorconfig em seu projeto:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Regras conexas

• CA1812: Evite classes internas não instanciadas