En-tête de fichier requis (IDE0073)
Propriété | Value |
---|---|
Identificateur de la règle | IDE0073 |
Titre | En-tête de fichier requis |
Catégorie | Style |
Sous-catégorie | Règles de langage (préférences de la directive using ) |
Langages applicables | C# et Visual Basic |
Options | file_header_template |
Vue d’ensemble
Cette règle de style concerne la spécification 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 de l’option est une chaîne non vide, l’en-tête de fichier spécifié est requis.
- Lorsque la valeur de l’option est
unset
ou une chaîne vide, un en-tête de fichier n’est pas requis.
Pour plus d’informations sur la configuration des options, consultez Format d’option.
file_header_template
Propriété | Valeur | Description |
---|---|---|
Nom d'option | file_header_template | |
Valeurs d’option | Chaîne non vide, contenant éventuellement un espace réservé {fileName} |
Préférez la chaîne en tant qu’en-tête de fichier requis. |
unset ou chaîne vide |
Un en-tête de fichier n’est pas requis. | |
Valeur d’option par défaut | 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
Supprimer un avertissement
Si vous voulez supprimer une seule violation, ajoutez des directives de préprocesseur à votre fichier source pour désactiver et réactiver la règle.
#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 sur un fichier, un dossier ou un projet, définissez sa gravité sur none
dans le fichier de configuration.
[*.{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.
[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Style.severity = none
Pour plus d’informations, consultez Comment supprimer les avertissements de l’analyse de code.
Voir aussi
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour