Compartir a través de

Encabezado de archivo obligatorio (IDE0073)

  • Artículo
Propiedad Valor
Identificador de la regla IDE0073
Título Requiere encabezado de archivo
Categoría Estilo
subcategoría Reglas de idioma (preferencias de la directivausing)
idiomas aplicables C# y Visual Basic
Opciones file_header_template

Visió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 del encabezado necesario estableciendo la opción file_header_template.

  • Cuando el valor de la opción es una cadena no vacía, requiera el encabezado de archivo especificado.
  • Cuando el valor de la opción es unset o una cadena vacía, no necesite un encabezado de archivo.

Para obtener información sobre cómo configurar opciones, vea Formato de opción.

plantilla_de_encabezado_de_archivo

Propiedad Valor Descripción
nombre de opción plantilla_de_encabezado_de_archivo
Valores de opción cadena no vacía, que opcionalmente contiene un marcador de posición {fileName} Prefiere la cadena de caracteres como encabezado de archivo requerido.
unset o cadena vacía No requiera un 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

Suprimir una advertencia

Si desea suprimir solo una 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 en el archivo de configuración de .

[*.{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, vea Cómo suprimir advertencias de análisis de código.

Consulte también