Dela via

Kräv filhuvud (IDE0073)

Egenskap Värde
regel-ID IDE0073
rubrik Kräv filhuvud
Kategori Stil
underkategori Språkregler (using direktivpreferenser)
Tillämpliga språk C# och Visual Basic
alternativ file_header_template

Överblick

Den här formatregeln handlar om att ange ett filhuvud överst i källkodsfilerna.

Alternativ

Ange den rubriktext som krävs genom att ange alternativet file_header_template.

  • När alternativvärdet är en icke-tom sträng kräver du 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.

filhuvudmall

Egenskap Värde Beskrivning
Alternativnamn filhuvudmall
Alternativvärden icke-tom sträng, som eventuellt innehåller en {fileName} platshållare Föredra strängen som det nödvändiga filhuvudet.
unset eller tom sträng Kräv 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

Undertrycka en varning

Om du bara vill förhindra en enda överträdelse lägger du till förprocessordirektiv i källfilen för att inaktivera och återaktiverar sedan regeln.

#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 kodformat 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.

Se även