Delen via

Bestandskoptekst vereist (IDE0073)

  • Artikel
Eigendom Waarde
regel-id IDE0073
titel Vereist bestandskoptekst
categorie Stijl
subcategorie Taalregels (using richtlijnvoorkeuren)
Toepasselijke talen C# en Visual Basic
opties file_header_template

Overzicht

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

Opties

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

  • Wanneer de optiewaarde een niet-lege tekenreeks is, moet u de opgegeven bestandskoptekst vereisen.
  • Wanneer de optiewaarde is unset of een lege tekenreeks, hebt u geen bestandskoptekst nodig.

Zie Option-indelingvoor meer informatie over het configureren van opties.

bestandkoptemplate

Eigenschap Waarde Beschrijving
optienaam bestandskop_sjabloon
Optiewaarden niet-lege tekenreeks, optioneel met een tijdelijke aanduiding voor {fileName} Geef de voorkeur aan de string als het vereiste bestandskopschrift.
unset of lege tekenreeks U hebt geen bestandskoptekst nodig.
standaardoptiewaarde 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 preprocessorrichtlijnen 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 ervan in op none in het configuratiebestand.

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

Als u alle regels voor de codestijl 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

Voor meer informatie, zie Hoe codeanalysewaarschuwingen te onderdrukken.

Zie ook