Kräv filhuvud (IDE0073)
Egenskap | Värde |
---|---|
Regel-ID | IDE0073 |
Rubrik | Kräv filhuvud |
Kategori | Format |
Underkategori | Språkregler (using direktivinställningar) |
Tillämpliga språk | C# och Visual Basic |
Alternativ | file_header_template |
Översikt
Den här formatregeln handlar om att ange ett filhuvud överst i källkodsfilerna.
Alternativ
Ange nödvändig rubriktext genom att file_header_template
ange alternativet .
- När alternativvärdet är en icke-tom sträng måste du ange det angivna filhuvudet.
- När alternativvärdet är
unset
eller en tom sträng, behöver du inte ett filhuvud.
Information om hur du konfigurerar alternativ finns i Alternativformat.
file_header_template
Egenskap | Värde | Beskrivning |
---|---|---|
Alternativnamn | file_header_template | |
Alternativvärden | icke-tom sträng, som eventuellt innehåller en {fileName} platshållare |
Prioritera strängen som det nödvändiga filhuvudet. |
unset eller tom sträng |
Kräver inte ett filhuvud. | |
Standardalternativvärde | 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
Ignorera en varning
Om du bara vill förhindra en enda överträdelse lägger du till preprocessor-direktiv i källfilen för att inaktivera och aktiverar sedan regeln igen.
#pragma warning disable IDE0073
// The code that's violating the rule is on this line.
#pragma warning restore IDE0073
Om du vill inaktivera regeln för en fil, mapp eller ett projekt anger du dess allvarlighetsgrad till none
i konfigurationsfilen.
[*.{cs,vb}]
dotnet_diagnostic.IDE0073.severity = none
Om du vill inaktivera alla regler i kodstil anger du allvarlighetsgraden för kategorin Style
till none
i konfigurationsfilen.
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
Mer information finns i Så här utelämnar du kodanalysvarningar.