Encabezado de archivo obligatorio (IDE0073)

  • Artículo
Propiedad Value
Identificador de la regla IDE0073
Título Encabezado de archivo obligatorio
Categoría Estilo
Subcategoría Reglas de lenguaje (using preferencias de directiva)
Lenguajes aplicables C# y Visual Basic
Opciones file_header_template

Información general

Esta regla de estilo se refiere a proporcionar un encabezado de archivo en la parte superior de los archivos de código fuente.

Opciones

Especifique el texto de encabezado necesario mediante el establecimiento de la opción file_header_template.

  • Si el valor de la opción es una cadena no vacía, el encabezado de archivo especificado es necesario.
  • Si el valor de la opción es unset o una cadena vacía, no se necesita un encabezado de archivo.

Para obtener información sobre la configuración de las opciones, vea Formato de opción.

file_header_template

Propiedad Value Descripción
Nombre de la opción file_header_template
Valores de opción cadena no vacía que opcionalmente contiene un marcador de posición {fileName} Se prefiere la cadena como encabezado de archivo necesario.
unset o cadena vacía No se necesita encabezado de archivo.
Valor de opción predeterminado 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

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para deshabilitar todas las reglas de estilo del código, establezca la gravedad de la categoría Style en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Consulte también