Partilhar via

Exigir cabeçalho de ficheiro (IDE0073)

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

Descrição Geral

Esta regra de estilo diz respeito ao fornecimento de um cabeçalho de ficheiro na parte superior dos ficheiros de código fonte.

Opções

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

  • Quando o valor da opção não estiver vazio, exija o cabeçalho de ficheiro especificado.
  • Quando o valor da opção é unset ou uma cadeia vazia, não é necessário um cabeçalho de ficheiro.

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

file_header_template

Propriedade Valor Descrição
Nome da opção file_header_template
Valores de opção cadeia não vazia, opcionalmente contendo um {fileName} marcador de posição Prefira a cadeia como o cabeçalho de ficheiro necessário.
unset ou cadeia vazia Não necessite de um cabeçalho de ficheiro.
Valor de opção predefinido 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 quiser suprimir apenas uma única violação, adicione diretivas de pré-processamento ao ficheiro de origem para desativar e, em seguida, reativar a regra.

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

Para desativar a regra para um ficheiro, pasta ou projeto, defina a sua gravidade como none no ficheiro de configuração.

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

Para desativar todas as regras de estilo de código, defina a gravidade da categoria Style como none no ficheiro de configuração.

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

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

Ver também