Vyžadovat hlavičku souboru (IDE0073)

Článek
02/08/2025

Vlastnost	Hodnota
ID pravidla	IDE0073
název	Vyžadovat hlavičku souboru
kategorie	Styl
podkategorie	Jazyková pravidla (předvolby direktiv`using`)
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 možnosti file_header_template.

Pokud je hodnota možnosti neprázdný řetězec, je požadována zadaná hlavička souboru.
Pokud je hodnota možnosti unset nebo prázdný řetězec, hlavička souboru se nevyžaduje.

Další informace o nastavení možností naleznete v části Formát možnosti.

šablona záhlaví souboru

Vlastnost / Nemovitost / Majetek	Hodnota	Popis
název možnosti	šablona záhlaví souboru
Možné hodnoty	Neprázdný řetězec, volitelně obsahující zástupný symbol `{fileName}`	Preferujte řetězec jako hlavičku požadovaného souboru.
	`unset` nebo prázdný řetězec	Nepožadujte 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, abyste pravidlo zakázali a znovu povolili.

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

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

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

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

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

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

Viz také

pravidla jazyka stylu kódu
referenční pravidel stylu kódu

Sdílet prostřednictvím