Erzwingen eines Dateiheaders (IDE0073)

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

Übersicht

Diese Stilregel bezieht sich auf die Bereitstellung eines Dateiheaders am Anfang von Quellcodedateien. Der erforderliche Header wird mit der Option file_header_template angegeben.

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

file_header_template

Eigenschaft Wert
Name der Option file_header_template
Optionswerte Nicht leere Zeichenfolge, optional mit einem {fileName}-Platzhalter, ist als erforderlicher Dateiheader zu bevorzugen.

unset oder leere Zeichenfolge: Der Dateiheader ist nicht erforderlich.
Standardoptionswert unset

Beispiel

// 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

Weitere Informationen