CA1305: Specificare IFormatProvider

Causa

Viene effettuata una chiamata a un metodo che ha un overload che accetta un argomento System.IFormatProvider, ma quell'overload non viene utilizzato.

Questa regola ignora le chiamate ai metodi .NET documentati come ignorano il parametro IFormatProvider. La regola ignora anche i metodi seguenti:

• Activator.CreateInstance
• ResourceManager.GetObject
• ResourceManager.GetString
• Boolean.ToString
• Char.ToString
• Guid.ToString

Descrizione regola

Quando un System.Globalization.CultureInfo oggetto o IFormatProvider non viene fornito, il valore predefinito fornito dal membro di overload potrebbe non avere l'effetto desiderato in tutte le impostazioni locali. Inoltre, i membri .NET scelgono le impostazioni culturali e la formattazione predefinite in base a presupposti che potrebbero non essere corretti per il codice. Per assicurarsi che il codice funzioni come previsto per gli scenari, è necessario fornire informazioni specifiche della cultura secondo le seguenti linee guida:

• Se il valore verrà visualizzato all'utente, usare la cultura attuale. Vedere CultureInfo.CurrentCulture.

• Se il valore verrà archiviato e reso accessibile dal software (salvato in un file o in un database), utilizzare la cultura invariabile. Vedere CultureInfo.InvariantCulture.

• Se non si conosce la destinazione del valore, chiedere al consumatore di dati o al fornitore di specificare la cultura.

Anche se il comportamento predefinito del metodo sovraccarico è appropriato per le proprie esigenze, è preferibile chiamare esplicitamente il sovraccarico specifico per la cultura, affinché il codice risulti autoesplicativo e più facilmente gestibile.

Come correggere le violazioni

Per correggere una violazione di questa regola, usare l'overload che accetta un argomento IFormatProvider. In alternativa, per utilizzare la cultura invariata, usa una stringa interpolata C# e passala insieme a String.Create(IFormatProvider, DefaultInterpolatedStringHandler) e CultureInfo.InvariantCulture, ad esempio:

string.Create(CultureInfo.InvariantCulture, $"{major}.{minor}.{build}.{revision}");

Quando eliminare gli avvisi

È sicuro eliminare un avviso da questa regola quando è certo che il formato predefinito è la scelta corretta e dove la gestibilità del codice non è una priorità di sviluppo importante.

Eliminare un avviso

Se si vuole eliminare una singola violazione, aggiungere direttive del preprocessore al file di origine per disabilitare e quindi riabilitare la regola.

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

Per disabilitare la regola per un file, una cartella o un progetto, impostarne la gravità none su nel file di configurazione.

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

Per altre informazioni, vedere Come eliminare gli avvisi di analisi del codice.

Configurare il codice da analizzare

Usare le opzioni seguenti per configurare le parti della codebase in cui eseguire questa regola.

• Escludere simboli specifici
• Escludere tipi specifici e i relativi tipi derivati

È possibile configurare queste opzioni solo per questa regola, per tutte le regole a cui si applicano o per tutte le regole di questa categoria (Globalizzazione) a cui si applicano. Per altre informazioni, vedere Opzioni di configurazione delle regole di qualità del codice.

Escludere simboli specifici

È possibile escludere simboli specifici, ad esempio tipi e metodi, dall'analisi impostando l'opzione excluded_symbol_names. Ad esempio, per specificare che la regola non deve essere eseguita in alcun codice all'interno di tipi denominati MyType, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Formati di nome simbolo consentiti nel valore dell'opzione (separati da |):

• Solo nome simbolo (include tutti i simboli con il nome, indipendentemente dal tipo o dallo spazio dei nomi contenitore).
• Nomi completi nel formato ID della documentazione del simbolo. Ogni nome di simbolo richiede un prefisso di tipo simbolo, ad esempio M: per i metodi, T: per i tipi e N: per i namespace.
• .ctor per costruttori e .cctor per costruttori statici.

Esempi:

Escludere tipi specifici e i relativi tipi derivati

È possibile escludere tipi specifici e i relativi tipi derivati dall'analisi impostando l'opzione excluded_type_names_with_derived_types. Ad esempio, per specificare che la regola non deve essere eseguita in alcun metodo all'interno di tipi denominati MyType e dei relativi tipi derivati, aggiungere la coppia chiave-valore seguente a un file con estensione editorconfig nel progetto:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

Formati di nome simbolo consentiti nel valore dell'opzione (separati da |):

• Solo nome di tipo (include tutti i tipi con il nome, indipendentemente dal tipo o dallo spazio dei nomi contenitore).
• Nomi completamente qualificati nel formato ID di documentazione del simbolo, con un prefisso facoltativo.

Esempi:

Esempio

Nel codice seguente la stringa viola la example1 regola CA1305. La example2 stringa soddisfa la regola CA1305 passando CultureInfo.CurrentCulture, che implementa IFormatProvider, a String.Format(IFormatProvider, String, Object). La example3 stringa soddisfa la regola CA1305 passando una stringa interpolata a String.Create(IFormatProvider, DefaultInterpolatedStringHandler)CultureInfo.InvariantCulture.

string name = "Georgette";

// Violates CA1305
string example1 = string.Format("Hello {0}", name);

// Satisfies CA1305
string example2 = string.Format(CultureInfo.CurrentCulture, "Hello {0}", name);

// Satisfies CA1305
string example3 = string.Create(CultureInfo.InvariantCulture, $"Hello {name}");

Regole correlate

• CA1304: Specificare CultureInfo

Vedi anche

• Usare la CultureInfo classe