Compartilhar via

Exigir cabeçalho de arquivo (IDE0073)

  • Artigo
Propriedade Valor
ID da regra IDE0073
Título Exigir cabeçalho de arquivo
Categoria Estilo
Subcategoria Regras de idioma (preferências da diretiva using)
idiomas aplicáveis C# e Visual Basic
Opções file_header_template

Visão geral

Essa regra de estilo diz respeito ao fornecimento de um cabeçalho de arquivo na parte superior dos arquivos de código-fonte.

Opções

Especifique o texto do cabeçalho necessário definindo a opção file_header_template.

  • Quando o valor da opção for uma cadeia de caracteres não vazia, exija o cabeçalho de arquivo especificado.
  • Quando o valor da opção for unset ou uma cadeia de caracteres vazia, não exija um cabeçalho de arquivo.

Para obter informações sobre como configurar opções, consulte Formato de opção.

modelo_de_cabeçalho_de_arquivo

Propriedade Valor Descrição
Nome da opção file_header_template
Valores das opções cadeia de caracteres não vazia, opcionalmente contendo um marcador de posição {fileName} Prefira a cadeia de caracteres como o cabeçalho de arquivo necessário.
unset ou cadeia de caracteres vazia Não exija um cabeçalho de arquivo.
valor de opção padrão 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 um aviso

Se você quiser suprimir apenas uma única violação, adicione diretivas de pré-processador ao arquivo de origem para desabilitar e, em seguida, habilitar novamente a regra.

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

Para desabilitar a regra de um arquivo, pasta ou projeto, defina sua severidade como none no arquivo de configuração .

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

Para desabilitar todas as regras de estilo de código, defina a severidade da categoria Style para none no arquivo de configuração .

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

Para obter mais informações, consulte Como suprimir avisos de análise de código.

Consulte também