CA1303: Harfleri yerelleştirilmiş parametreler olarak göndermeyin

Makale
01/30/2024

Özellik	Değer
Kural Kimliği	CA1303
Başlık	Harfleri yerelleştirilmiş parametreler olarak göndermeyin
Kategori	Globalleştirme
Hataya neden olan veya bozulmayan düzeltme	Hataya neden olmayan
.NET 8'de varsayılan olarak etkin	Hayır

Neden

Bir yöntem bir dize değişmez değerini bir .NET oluşturucusna veya yöntemine parametre olarak geçirir ve bu dize yerelleştirilebilir olmalıdır.

Değişmez değer dizesi bir parametreye veya özelliğe değer olarak geçirildiğinde ve aşağıdaki durumlardan biri veya daha fazlası doğru olduğunda bu uyarı tetiklenir:

LocalizableAttribute parametresinin veya özelliğinin özniteliği olarak trueayarlanır.
Değişmez değer dizesi, veya Console.Write yöntemi aşırı yüklemesinin veya Console.WriteLinestring format parametresine geçirilirstring value.
Kural CA1303 adlandırma buluşsalını kullanacak şekilde yapılandırılmıştır ve parametre veya özellik adı , Messageveya Captiontümceciği Textiçerir.

Varsayılan olarak, bu kural tüm kod tabanını analiz eder, ancak bu yapılandırılabilir.

Kural açıklaması

Kaynak koda eklenmiş dize değişmez değerlerinin yerelleştirilmesi zordur.

İhlalleri düzeltme

Bu kuralın ihlalini düzeltmek için dize değişmez değerini sınıfın ResourceManager bir örneği aracılığıyla alınan bir dizeyle değiştirin.

Yerelleştirilmiş dize gerektirmeyen yöntemler için, aşağıdaki yollarla gereksiz CA1303 uyarılarını ortadan kaldırabilirsiniz:

Adlandırma buluşsal seçeneği etkinse parametreyi veya özelliği yeniden adlandırın.
parametresinde LocalizableAttribute veya özelliğinde özniteliğini kaldırın veya ()[Localizable(false)] olarak false ayarlayın.

Uyarıların ne zaman bastırılması gerekiyor?

Aşağıdaki deyimlerden biri geçerliyse, bu kuraldan bir uyarıyı engellemek güvenlidir:

Kod kitaplığı yerelleştirilmeyecek.
Dize, kod kitaplığını kullanan son kullanıcıya veya geliştiriciye gösterilmez.

Uyarıyı gizleme

Yalnızca tek bir ihlali engellemek istiyorsanız, kuralı devre dışı bırakmak ve sonra yeniden etkinleştirmek için kaynak dosyanıza ön işlemci yönergeleri ekleyin.

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

Bir dosya, klasör veya projenin kuralını devre dışı bırakmak için, yapılandırma dosyasındaki önem derecesini noneolarak ayarlayın.

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

Daha fazla bilgi için bkz . Kod analizi uyarılarını gizleme.

Çözümlemek için kod yapılandırma

Bu kuralın kod tabanınızın hangi bölümlerinde çalıştırılacaklarını yapılandırmak için aşağıdaki seçenekleri kullanın.

Belirli simgeleri hariç tutma
Belirli türleri ve türetilmiş türlerini dışlama
Adlandırma buluşsal özelliğini kullanma

Bu seçenekleri yalnızca bu kural, geçerli olduğu tüm kurallar veya bu kategorideki (Genelleştirme) tüm kurallar için yapılandırabilirsiniz. Daha fazla bilgi için bkz . Kod kalitesi kuralı yapılandırma seçenekleri.

Belirli simgeleri hariç tutma

Türler ve yöntemler gibi belirli simgeleri analizden hariç tutabilirsiniz. Örneğin, kuralın adlı MyTypetürlerdeki herhangi bir kodda çalışmaması gerektiğini belirtmek için, projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

Seçenek değerinde izin verilen simge adı biçimleri (ile |ayrılmış):

Yalnızca sembol adı (içeren tür veya ad alanı ne olursa olsun, ada sahip tüm simgeleri içerir).
Simgenin belge kimliği biçimindeki tam adlar. Her simge adı için yöntemlerT:, türler ve N: ad alanları gibi M: bir sembol türü ön eki gerekir.
.ctor oluşturucular ve .cctor statik oluşturucular için.

Örnekler:

Seçenek Değeri	Özet
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType`	adlı `MyType`tüm simgelerle eşleşir.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1\|MyType2`	veya `MyType2`adlı `MyType1` tüm simgelerle eşleşir.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType)`	Belirtilen tam imza ile belirli bir yöntemi `MyMethod` eşleştirir.
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)\|M:NS2.MyType2.MyMethod2(ParamType)`	Belirli yöntemlerle `MyMethod1` ve `MyMethod2` ilgili tam imzalarla eşleşir.

Belirli türleri ve türetilmiş türlerini dışlama

Belirli türleri ve türetilmiş türlerini analizden dışlayabilirsiniz. Örneğin, kuralın adlı MyType ve türetilmiş türleri içindeki hiçbir yöntemde çalışmaması gerektiğini belirtmek için, projenizdeki bir .editorconfig dosyasına aşağıdaki anahtar-değer çiftini ekleyin:

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

Seçenek değerinde izin verilen simge adı biçimleri (ile |ayrılmış):

Yalnızca tür adı (içeren tür veya ad alanına bakılmaksızın adı olan tüm türleri içerir).
Simgenin belge kimliği biçiminde, isteğe bağlı T: ön ek içeren tam adlar.

Örnekler:

Seçenek Değeri	Özet
`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType`	Adlı `MyType` tüm türleri ve türetilmiş türlerinin tümünü eşleştirir.
`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType1\|MyType2`	veya `MyType2` adlı `MyType1` tüm türleri ve türetilmiş türlerinin tümünü eşleştirir.
`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS.MyType`	Belirli bir türü `MyType` verilen tam adla ve türetilmiş tüm türleriyle eşleştirir.
`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS1.MyType1\|M:NS2.MyType2`	Belirli türleri `MyType1` ve `MyType2` ilgili tam adlarla ve bunların türetilmiş tüm türleriyle eşleşir.

Adlandırma buluşsal özelliğini kullanma

parametrelerin veya , Messageiçeren özellik adlarının Caption bu kuralı tetikleyip Texttetiklemeyeceğini yapılandırabilirsiniz.

dotnet_code_quality.CA1303.use_naming_heuristic = true

Örnek

Aşağıdaki örnekte, iki bağımsız değişkenden biri aralık dışında olduğunda konsola yazan bir yöntem gösterilmektedir. Bağımsız değişken denetimi için hour , bu kuralı ihlal eden bir değişmez dize geçirilir Console.WriteLine. minute Bağımsız değişken denetimi için, aracılığıyla alınan ResourceManager bir dize, kuralı karşılayan öğesine Console.WriteLinegeçirilir.

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

Aracılığıyla paylaş