Partager via

Règles d’affectation des noms

  • Article

Les règles de nommage prennent en charge le respect des conventions d’affectation de noms des instructions 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 de l'énumération dont le nom contient le terme "reserved" n'est pas utilisé actuellement, mais constitue un espace réservé à renommer ou à supprimer dans une version ultérieure. Renommer ou supprimer un membre constitue une modification avec rupture.
CA1707 : Les identificateurs ne doivent pas contenir de traits de soulignement Par convention, les noms d'identificateurs ne contiennent pas de trait de soulignement (_). Cette règle vérifie les espaces de noms, types, membres et 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 être dotés d'un suffixe correct Par convention, les noms des types qui étendent certains types de base ou qui implémentent certaines interfaces, ou encore des types dérivés de ces types, présentent un suffixe associé au type de base ou à l’interface.
CA1711 : Les identificateurs ne doivent pas porter un suffixe incorrect Par convention, seuls les noms des types qui étendent certains types de base ou qui implémentent certaines interfaces, ou les 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écédés du 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 être munis d'un préfixe Before ou After Le nom d'un événement commence par « Before » ou « After ». Pour nommer des événements associés déclenchés dans une séquence spécifique, utilisez le présent ou le 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 comporte l’attribut System.FlagsAttribute et son nom ne se termine pas par « s ». Les types marqués avec FlagsAttribute ont des noms au pluriel, car l’attribut indique que plusieurs valeurs peuvent être spécifiées.
CA1715 : Les identificateurs doivent être dotés d'un préfixe correct Le nom d’une interface extérieurement visible ne commence pas par un « I » majuscule. Le nom d’un paramètre de type générique sur un type ou une méthode extérieurement visible ne commence pas par un « T » majuscule.
CA1716 : Les identificateurs ne doivent pas correspondre à des 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 des espaces de noms et des types ne doivent pas correspondre aux mots clés définis par les langages qui ciblent le Common Language Runtime.
CA1717 : Seuls les noms des enums FlagsAttribute doivent être au pluriel Selon les conventions d'attribution de nom, un nom au pluriel pour une énumération indique que plusieurs valeurs de l'énumération peuvent être spécifiées simultanément.
CA1720 : Les identificateurs ne doivent pas contenir de noms de types Le nom d'un paramètre dans un membre extérieurement visible contient un nom de type de données, ou le nom d'un membre extérieurement visible contient un nom de type de données spécifique à une langue.
CA1721 : Les noms des propriétés ne doivent pas être identiques à ceux des méthodes Get Le nom d'un membre public ou protégé commence par « Get ». Sinon, il correspond au nom d'une propriété publique ou protégée. Les méthodes et propriétés « Get » doivent porter des noms distinguant 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. Enfreindre cette règle peut réduire la facilité d’utilisation de la bibliothèque.
CA1725 : Les noms des 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 dans la déclaration de base peut créer une confusion pour déterminer si la méthode est une 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.