Sdílet prostřednictvím

Vyžadovat hlavičku souboru (IDE0073)

  • Článek
Vlastnost Hodnota
ID pravidla IDE0073
Název Vyžadovat hlavičku souboru
Kategorie Styl
Subcategory Jazyková pravidla (using předvolby direktiv)
Příslušné jazyky C# a Visual Basic
Možnosti file_header_template

Přehled

Toto pravidlo stylu se týká poskytnutí hlavičky souboru nad soubory zdrojového kódu.

Možnosti

Zadejte požadovaný text záhlaví nastavením file_header_template možnosti .

  • Pokud je hodnotou možnosti neprázdný řetězec, vyžaduje se zadaná hlavička souboru.
  • Pokud je unset hodnota možnosti nebo prázdný řetězec, nevyžadují hlavičku souboru.

Informace o konfiguraci možností najdete v tématu Formát možností.

file_header_template

Vlastnost Hodnota Popis
Název možnosti file_header_template
Hodnoty možností neprázdný řetězec, volitelně obsahující {fileName} zástupný symbol Preferujte řetězec jako požadovanou hlavičku souboru.
unset nebo prázdný řetězec Nevyžaduje hlavičku souboru.
Výchozí hodnota možnosti 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

Potlačení upozornění

Pokud chcete potlačit pouze jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, které pravidlo zakažou a znovu ho povolí.

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

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v konfiguračním souboru na none .

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

Pokud chcete zakázat všechna pravidla stylu kódu, nastavte v konfiguračním souboru závažnost pro kategorii Style na none .

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

Další informace najdete v tématu Jak potlačit upozornění analýzy kódu.

Viz také