Lire en anglais

Partager via

Exiger un en-tête de fichier (IDE0073)

  • Article
Propriété Valeur
Identificateur de la règle IDE0073
Titre Exiger un en-tête de fichier
Catégorie Style
sous-catégorie Règles linguistiques (préférences de directiveusing)
langues applicables C# et Visual Basic
Options file_header_template

Aperçu

Cette règle de style concerne la fourniture d’un en-tête de fichier en haut des fichiers de code source.

Options

Spécifiez le texte d’en-tête requis en définissant l’option file_header_template.

  • Lorsque la valeur d’option est une chaîne non vide, exigez l’en-tête de fichier spécifié.
  • Lorsque la valeur d’option est unset ou une chaîne vide, ne nécessite pas d’en-tête de fichier.

Pour plus d’informations sur la configuration des options, consultez le format d’option .

file_header_template

Propriété Valeur Description
nom de l’option file_header_template
Valeurs d’option chaîne non vide, contenant éventuellement un espace réservé {fileName} Préférez la chaîne comme en-tête de fichier requis.
unset ou chaîne vide Ne nécessite pas d’en-tête de fichier.
valeur d’option par défaut unset
C# 
// 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 { }
}

Supprimer un avertissement

Si vous souhaitez supprimer une seule violation, ajoutez des directives de préprocesseur à votre fichier source pour désactiver, puis réactivez la règle.

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

Pour désactiver la règle d’un fichier, d’un dossier ou d’un projet, définissez sa gravité sur none dans le fichier de configuration .

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

Pour désactiver toutes les règles de style de code, définissez la gravité de la catégorie Style sur none dans le fichier de configuration .

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

Pour plus d’informations, consultez Comment supprimer les avertissements d’analyse du code.

Voir aussi