Règles de nommage
Les règles de nommage prennent en charge l’adhésion aux conventions de nommage des directives de conception .NET.
Contenu de cette section
Règle | Description |
---|---|
CA1700 : ne nommez pas les valeurs enum « Reserved » | Cette règle suppose qu’un membre d’énumération qui a un nom qui contient « réservé » n’est pas actuellement utilisé, mais qu’il s’agit d’un espace réservé à renommer ou à supprimer dans une version ultérieure. Le changement de nom ou la suppression d’un membre est un changement majeur. |
CA1707 : les identificateurs ne doivent pas contenir de traits de soulignement | Par convention, les noms d’identificateurs ne contiennent pas le caractère de trait de soulignement (_). Cette règle vérifie les espaces de noms, les types, les membres et les paramètres. |
CA1708 : les identificateurs ne doivent pas différer uniquement par leur casse | Les identificateurs des espaces de noms, types, membres et paramètres ne peuvent pas différer uniquement par la casse car les langages qui ciblent le Common Language Runtime ne sont pas tenus de respecter celle-ci. |
CA1710 : les identificateurs doivent avoir un suffixe correct | Par convention, les noms de types qui étendent certains types de base ou qui implémentent certaines interfaces, ou types dérivés de ces types, ont un suffixe associé au type de base ou à l’interface. |
CA1711 : les identificateurs ne doivent pas avoir de suffixe incorrect | Par convention, seuls les noms de types qui étendent certains types de base ou qui implémentent certaines interfaces, ou types dérivés de ces types, doivent se terminer par des suffixes réservés spécifiques. Les autres noms de types ne doivent pas utiliser ces suffixes réservés. |
CA1712 : n’ajoutez pas le nom de type en guise de préfixe à des valeurs enum | Les noms des membres d’énumération ne sont pas préfixés par le nom de type, car les informations de type sont censées être fournies par les outils de développement. |
CA1713 : les événements ne doivent pas comporter de préfixe avant ou après | Le nom d’un événement commence par « Before » ou « After ». Pour nommer les événements associés déclenchés dans une séquence spécifique, utilisez le temps présent ou passé pour indiquer la position relative dans la séquence d’actions. |
CA1714 : les noms des enums Flags doivent être au pluriel | Une énumération publique a l’attribut System.FlagsAttribute et son nom ne se termine pas par « s ». Les types marqués avec FlagsAttribute ont des noms qui sont pluriels, car l’attribut indique que plusieurs valeurs peuvent être spécifiées. |
CA1715 : Les identificateurs doivent avoir un préfixe correct | Le nom d’une interface visible en externe ne commence pas par un capital « I ». Le nom d’un paramètre de type générique sur un type ou une méthode visible en externe ne commence pas par un « T » majuscule. |
CA1716 : Les identificateurs ne doivent pas correspondre aux mots clés | Un nom d’espace de noms ou un nom de type correspond à un mot clé réservé dans un langage de programmation. Les identificateurs pour les espaces de noms et les types ne doivent pas correspondre aux mots clés définis par les langages qui ciblent le Common Language Runtime. |
CA1717 : Seules les énumérations FlagsAttribute doivent avoir des noms pluriels | Les conventions d’affectation de noms déterminent qu’un nom pluriel pour une énumération indique que plusieurs valeurs de l’énumération peuvent être spécifiées en même temps. |
CA1720 : les identificateurs ne doivent pas contenir de noms de types | Le nom d’un paramètre dans un membre visible en externe contient un nom de type de données, ou le nom d’un membre visible en externe contient un nom de type de données spécifique à la langue. |
CA1721 : Les noms de propriétés ne doivent pas correspondre aux méthodes get | Le nom d’un membre public ou protégé commence par « Get » et correspond sinon au nom d’une propriété publique ou protégée. Les méthodes et propriétés « Get » doivent avoir des noms qui distinguent clairement leur fonction. |
CA1724 : les noms de types ne doivent pas être identiques aux espaces de noms | Les noms de type ne doivent pas correspondre aux noms des espaces de noms .NET. La violation de cette règle peut réduire la facilité d’utilisation de la bibliothèque. |
CA1725 : Les noms de paramètres doivent correspondre à la déclaration de base | La désignation cohérente des paramètres dans une hiérarchie de substitution augmente la facilité d'utilisation des substitutions de méthode. Un nom de paramètre dans une méthode dérivée qui diffère du nom de la déclaration de base peut entraîner une confusion quant à la substitution de la méthode de base ou à une nouvelle surcharge de la méthode. |
CA1727 : utilisez PascalCase pour les espaces réservés nommés | Utilisez PascalCase pour les espaces réservés nommés dans le modèle de message de journalisation. |
Collaborer avec nous sur GitHub
La source de ce contenu se trouve sur GitHub, où vous pouvez également créer et examiner les problèmes et les demandes de tirage. Pour plus d’informations, consultez notre guide du contributeur.