Dosya üst bilgisi gerektir (IDE0073)

  • Makale
Özellik Değer
Kural Kimliği IDE0073
Başlık Dosya üst bilgisi gerektir
Kategori Stil
Alt Kategori Dil kuralları (using yönerge tercihleri)
Geçerli diller C# ve Visual Basic
Seçenekler file_header_template

Genel Bakış

Bu stil kuralı, kaynak kod dosyalarının en üstünde bir dosya üst bilgisi sağlanmasıyla ilgilidir.

Seçenekler

Seçeneği ayarlayarak file_header_template gerekli üst bilgi metnini belirtin.

  • Seçenek değeri boş olmayan bir dize olduğunda, belirtilen dosya üst bilgisini gerekli kılar.
  • Seçenek değeri veya boş bir dize olduğunda unset , dosya üst bilgisi gerektirmez.

Seçenekleri yapılandırma hakkında bilgi için bkz. Seçenek biçimi.

file_header_template

Özellik Değer Açıklama
Seçenek adı file_header_template
Seçenek değerleri boş olmayan dize, isteğe bağlı olarak bir {fileName} yer tutucu içeriyor Dizeyi gerekli dosya üst bilgisi olarak tercih edin.
unset veya boş dize Dosya üst bilgisi gerektirmez.
Varsayılan seçenek değeri unset 
// file_header_template = Copyright (c) SomeCorp. All rights reserved.\nLicensed under the xyz license.

// Copyright (c) SomeCorp. All rights reserved.
// Licensed under the xyz license.
namespace N1
{
    class C1 { }
}

// file_header_template = unset
//      OR
// file_header_template =
namespace N2
{
    class C2 { }
}

' file_header_template = Copyright (c) SomeCorp. All rights reserved.\nLicensed under the xyz license.

' Copyright (c) SomeCorp. All rights reserved.
' Licensed under the xyz license.
Namespace N1
    Class C1
    End Class
End Namespace

' file_header_template = unset
'      OR
' file_header_template =
Namespace N2
    Class C2
    End Class
End Namespace

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 önişlemci yönergeleri ekleyin.

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

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

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

Kod stili kuralların tümünü devre dışı bırakmak için Stylenone, kategorinin önem derecesini yapılandırma dosyasında olarak ayarlayın.

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none

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

Ayrıca bkz.