CA1303: Não passar literais como parâmetros localizados

Causa

Um método transmite um literal de cadeia de caracteres como parâmetro para um construtor ou método do .NET, e essa cadeia de caracteres deve ser localizável.

Esse aviso é gerado quando uma cadeia de caracteres literal é passada como um valor para um parâmetro ou propriedade e uma ou mais das seguintes situações são verdadeiras:

• O atributo LocalizableAttribute do parâmetro ou da propriedade é definido como true.

• A cadeia de caracteres literal é passada para o parâmetro string value ou string format de uma sobrecarga de método Console.Write ou Console.WriteLine.

• A regra CA1303 está configurada para usar a heurística de nomenclatura e um nome de propriedade ou parâmetro contém a frase Text, Message ou Caption.

Por padrão, essa regra analisa toda a base de código, mas isso é configurável.

Descrição da regra

Literais de cadeia de caracteres inseridos no código-fonte são difíceis de localizar.

Como corrigir violações

Para corrigir uma violação dessa regra, substitua o literal de cadeia de caracteres por uma cadeia de caracteres recuperada por meio de uma instância da classe ResourceManager.

Para métodos que não exigem cadeias de caracteres localizadas, você pode eliminar avisos de CA1303 desnecessários das seguintes maneiras:

• Se a opção heurística de nomenclatura estiver habilitada, renomeie o parâmetro ou a propriedade.
• Remova o atributo LocalizableAttribute no parâmetro ou na propriedade ou defina-o como false ([Localizable(false)]).

Quando suprimir avisos

Será seguro suprimir um aviso dessa regra se uma das seguintes instruções se aplicar:

• A biblioteca de códigos não será localizada.
• A cadeia de caracteres não é exposta ao usuário final ou a um desenvolvedor usando a biblioteca de códigos.

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 CA1303
// The code that's violating the rule is on this line.
#pragma warning restore CA1303

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.CA1303.severity = none

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

Configurar código para analisar

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

• Excluir símbolos específicos
• Excluir tipos específicos e seus tipos derivados
• Usar heurística de nomenclatura

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

Excluir símbolos específicos

Você pode excluir da análise símbolos específicos, como tipos e métodos. Por exemplo, para especificar que a regra não deve ser executada em nenhum código dentro de tipos nomeados MyType, adicione o seguinte par chave-valor a um arquivo .editorconfig no seu projeto:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Formatos de nome de símbolo permitidos no valor da opção (separados por |):

• Somente nome do símbolo (inclui todos os símbolos com o nome, independentemente do tipo ou namespace que contém).
• Nomes totalmente qualificados no formato de ID de documentação do símbolo. Cada nome de símbolo requer um prefixo do tipo símbolo, como M: para métodos, T: para tipos e N: para namespaces.
• .ctor para construtores e .cctor para construtores estáticos.

Exemplos:

Excluir tipos específicos e seus tipos derivados

Você pode excluir tipos específicos e seus tipos derivados da análise. Por exemplo, para especificar que a regra não deve ser executada em nenhum método dentro de tipos nomeados MyType e seus tipos derivados, adicione o seguinte par chave-valor a um arquivo .editorconfig no seu projeto:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

Formatos de nome de símbolo permitidos no valor da opção (separados por |):

• Somente nome do tipo (inclui todos os tipos com o nome, independentemente do tipo ou namespace que contém).
• Nomes totalmente qualificados no formato de ID de documentação do símbolo, com um prefixo opcional T:.

Exemplos:

Usar heurística de nomenclatura

Você pode configurar se os parâmetros ou nomes de propriedade que contêm, Text, Message ou Caption dispararão essa regra.

dotnet_code_quality.CA1303.use_naming_heuristic = true

Exemplo

O exemplo a seguir mostra um método que grava no console quando um de seus dois argumentos está fora do intervalo. Para a verificação do argumento hour, uma cadeia de caracteres literal é passada para Console.WriteLine, o que viola essa regra. Para a verificação do argumento minute, uma cadeia de caracteres que é recuperada por meio de um ResourceManager é passada para Console.WriteLine, o que cumpre a regra.

<Assembly: System.Resources.NeutralResourcesLanguageAttribute("en-US")>
Namespace GlobalizationLibrary

    Public Class DoNotPassLiterals

        Dim stringManager As System.Resources.ResourceManager

        Sub New()
            stringManager = New System.Resources.ResourceManager(
                "en-US", System.Reflection.Assembly.GetExecutingAssembly())
        End Sub

        Sub TimeMethod(hour As Integer, minute As Integer)

            If (hour < 0 Or hour > 23) Then
                'CA1303 fires because a literal string
                'is passed as the 'value' parameter.
                Console.WriteLine("The valid range is 0 - 23.")
            End If

            If (minute < 0 Or minute > 59) Then
                Console.WriteLine(
                    stringManager.GetString("minuteOutOfRangeMessage",
                        System.Globalization.CultureInfo.CurrentUICulture))
            End If

        End Sub

    End Class

End Namespace

public class DoNotPassLiterals
{
    ResourceManager stringManager;
    public DoNotPassLiterals()
    {
        stringManager = new ResourceManager("en-US", Assembly.GetExecutingAssembly());
    }

    public void TimeMethod(int hour, int minute)
    {
        if (hour < 0 || hour > 23)
        {
            // CA1303 fires because a literal string
            // is passed as the 'value' parameter.
            Console.WriteLine("The valid range is 0 - 23.");
        }

        if (minute < 0 || minute > 59)
        {
            Console.WriteLine(stringManager.GetString(
            "minuteOutOfRangeMessage", CultureInfo.CurrentUICulture));
        }
    }
}

Confira também

• Recursos em aplicativos .NET
• Solicitação da comunidade para alteração de comportamento