Delen via

Bestandsheader vereisen (IDE0073)

  • Artikel
Eigenschap Waarde
Regel-id IDE0073
Titel Bestandskoptekst vereisen
Categorie Stijl
Subcategorie Taalregels (using instructievoorkeuren)
Toepasselijke talen C# en Visual Basic
Opties file_header_template

Overzicht

Deze stijlregel heeft betrekking op het verstrekken van een bestandsheader boven aan broncodebestanden.

Opties

Geef de vereiste koptekst op door de optie in te file_header_template stellen.

  • Als de waarde van de optie een niet-lege tekenreeks is, moet u de opgegeven bestandsheader vereisen.
  • Als de waarde van de optie of een lege tekenreeks is unset , hebt u geen bestandsheader nodig.

Zie Optie-indeling voor meer informatie over het configureren van opties.

file_header_template

Eigenschap Waarde Beschrijving
Naam van optie file_header_template
Optiewaarden niet-lege tekenreeks, optioneel met een {fileName} tijdelijke aanduiding Geef de voorkeur aan de tekenreeks als de vereiste bestandsheader.
unset of lege tekenreeks U hebt geen bestandsheader nodig.
Waarde van standaardoptie 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

Een waarschuwing onderdrukken

Als u slechts één schending wilt onderdrukken, voegt u preprocessor-instructies toe aan uw bronbestand om de regel uit te schakelen en vervolgens opnieuw in te schakelen.

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

Als u de regel voor een bestand, map of project wilt uitschakelen, stelt u de ernst in op none in het configuratiebestand.

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

Als u alle codestijlregels wilt uitschakelen, stelt u de ernst voor de categorie Style in op none in het configuratiebestand.

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

Zie Waarschuwingen voor codeanalyse onderdrukken voor meer informatie.

Zie ook