Wymagaj nagłówka pliku (IDE0073)

  • Artykuł
Właściwość Wartość
Identyfikator zasady IDE0073
Tytuł Wymagaj nagłówka pliku
Kategoria Styl
Subcategory (Podkategoria) Reguły językowe (using preferencje dyrektywy)
Odpowiednie języki C# i Visual Basic
Opcje file_header_template

Omówienie

Ta reguła stylu dotyczy dostarczania nagłówka pliku w górnej części plików kodu źródłowego.

Opcje

Określ wymagany tekst nagłówka file_header_template , ustawiając opcję.

  • Gdy wartość opcji jest ciągiem niepustym, wymagaj określonego nagłówka pliku.
  • Jeśli wartość opcji to unset lub pusty ciąg, nie wymagaj nagłówka pliku.

Aby uzyskać informacje na temat konfigurowania opcji, zobacz Format opcji.

file_header_template

Właściwość Wartość Opis
Nazwa opcji file_header_template
Wartości opcji ciąg niepusty, opcjonalnie zawierający {fileName} symbol zastępczy Preferuj ciąg jako wymagany nagłówek pliku.
unset lub pusty ciąg Nie wymagaj nagłówka pliku.
Wartość opcji domyślnej 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

Pomijanie ostrzeżenia

Jeśli chcesz pominąć tylko jedno naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.

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

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.

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

Aby wyłączyć wszystkie reguły stylu kodu, ustaw ważność kategorii Style na none w pliku konfiguracji.

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

Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia analizy kodu.

Zobacz też