CA1305: Specificare IFormatProvider

  • Articolo
Proprietà valore
ID regola CA1305
Title Specificare IFormatProvider
Categoria Globalizzazione
Correzione che causa un'interruzione o un'interruzione Nessuna interruzione
Abilitato per impostazione predefinita in .NET 8 No

Causa

Viene eseguita una chiamata a un metodo con un overload che accetta un System.IFormatProvider argomento e tale overload non viene chiamato.

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

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 impostazioni cultura e formattazione predefinite in base ai presupposti che potrebbero non essere corretti per il codice. Per assicurarsi che il codice funzioni come previsto per gli scenari, è necessario fornire informazioni specifiche delle impostazioni cultura in base alle linee guida seguenti:

  • Se il valore verrà visualizzato all'utente, usare le impostazioni cultura correnti. Vedere CultureInfo.CurrentCulture.

  • Se il valore verrà archiviato e accessibile dal software (salvato in modo permanente in un file o in un database), usare le impostazioni cultura invarianti. Vedere CultureInfo.InvariantCulture.

  • Se non si conosce la destinazione del valore, chiedere al consumer di dati o al provider di specificare le impostazioni cultura.

Anche se il comportamento predefinito del membro di overload è appropriato per le proprie esigenze, è preferibile chiamare in modo esplicito l'overload specifico delle impostazioni cultura in modo che il codice sia autodocumentato e gestito più facilmente.

Come correggere le violazioni

Per correggere una violazione di questa regola, usare l'overload che accetta un IFormatProvider argomento. In alternativa, per usare le impostazioni cultura invarianti, usare una stringa interpolata C# e passarla insieme a String.Create(IFormatProvider, DefaultInterpolatedStringHandler)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.

È possibile configurare queste opzioni solo per questa regola, per tutte le regole a cui si applica o per tutte le regole di questa categoria (globalizzazione) a cui si applica. 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. 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 gli spazi dei nomi.
  • .ctor per costruttori e .cctor per costruttori statici.

Esempi:

Valore opzione Riepilogo
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType Corrisponde a tutti i simboli denominati MyType.
dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1|MyType2 Corrisponde a tutti i simboli denominati MyType1 o MyType2.
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType) Corrisponde a un metodo MyMethod specifico con la firma completa specificata.
dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)|M:NS2.MyType2.MyMethod2(ParamType) Trova la corrispondenza con metodi MyMethod1 specifici e MyMethod2 con le rispettive firme complete.

Escludere tipi specifici e i relativi tipi derivati

È possibile escludere tipi specifici e i relativi tipi derivati dall'analisi. 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 completi nel formato ID della documentazione del simbolo, con un prefisso facoltativoT:.

Esempi:

Valore opzione Riepilogo
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType Corrisponde a tutti i tipi denominati MyType e a tutti i relativi tipi derivati.
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType1|MyType2 Corrisponde a tutti i tipi denominati MyType1 o MyType2 e a tutti i relativi tipi derivati.
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS.MyType Corrisponde a un tipo MyType specifico con il nome completo specificato e tutti i relativi tipi derivati.
dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS1.MyType1|M:NS2.MyType2 Corrisponde a tipi MyType1 specifici e MyType2 con i rispettivi nomi completi e tutti i relativi tipi derivati.

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 insieme CultureInfo.InvariantCulturea String.Create(IFormatProvider, DefaultInterpolatedStringHandler) .

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}");

Vedi anche