Freigeben über

Erzwingen eines Dateiheaders (IDE0073)

  • Artikel
Eigenschaft Wert
Regel-ID IDE0073
Titel Dateiheader erzwingen
Kategorie Stil
Unterkategorie Sprachregeln (Einstellungen für using-Direktiven)
Gültige Sprachen C# und Visual Basic
Optionen file_header_template

Übersicht

Diese Stilregel bezieht sich auf die Bereitstellung eines Dateiheaders am Anfang von Quellcodedateien.

Optionen

Geben Sie den erforderlichen Headertext an, indem Sie die file_header_template-Option festlegen.

  • Wenn der Wert der Option eine nicht leere Zeichenfolge ist, wird der angegebene Dateiheader erzwungen.
  • Wenn der Optionswert unset oder eine leeren Zeichenfolge ist, benötigen Sie keinen Dateiheader.

Informationen zum Konfigurieren von Optionen finden Sie unter Optionsformat.

file_header_template

Eigenschaft Wert Beschreibung
Name der Option file_header_template
Optionswerte Nicht leere Zeichenfolge, die optional einen {fileName}-Platzhalter enthält Bevorzugen Sie die Zeichenfolge als erforderlichen Dateiheader.
unset oder leere Zeichenfolge Erfordert keinen Dateiheader.
Standardoptionswert 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

Unterdrücken einer Warnung

Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.

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

Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.

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

Um alle Regeln im Code-Stil zu deaktivieren, setzen Sie den Schweregrad für die Kategorie in der KonfigurationsdateiStyle auf none.

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

Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.

Siehe auch