- 10/22/2008
- 2 minutes de lecture
-
-
K -
n -
B -
D -
n -
+10
.
-
Les directives de ce chapitre exposent une méthode simple pour utiliser la casse qui, lorsqu’elles sont appliquées de manière cohérente, rendent les identifiants des types, des membres et des paramètres faciles à lire.
Règles de capitalisation pour les identificateurs
Pour différencier les mots d’un identificateur, mettez en majuscule la première lettre de chaque mot de l’identificateur. N’utilisez pas de caractères de soulignement pour différencier les mots, ou d’ailleurs, n’importe où dans les identificateurs. Il existe deux façons appropriées de mettre en majuscule les identificateurs, selon l’utilisation de l’identificateur :
-
PascalCasing
-
camelCasing
La convention PascalCasing, utilisée pour tous les identificateurs à l’exception des noms de paramètres, met en majuscule le premier caractère de chaque mot (y compris les acronymes de plus de deux lettres), comme le montrent les exemples suivants :
PropertyDescriptorHtmlTag
Un cas particulier est fait pour les acronymes de deux lettres dans lesquels les deux lettres sont en majuscule, comme le montre l’identifiant suivant :
IOStream
La convention camelCasing, utilisée uniquement pour les noms de paramètres, met en majuscule le premier caractère de chaque mot sauf le premier mot, comme le montrent les exemples suivants. Comme le montre également l’exemple, les acronymes à deux lettres qui commencent un identifiant en casse camel sont tous deux en minuscules.
propertyDescriptorioStreamhtmlTag
✔️ UTILISER la casse Pascal pour tous les membres publics, les types et les espaces de noms composés de plusieurs mots.
✔️ DO utiliser la casse camel pour les noms de paramètres.
Le tableau suivant décrit les règles de capitalisation pour différents types d’identifiants.
| Identifiant | Case | Exemple |
|---|---|---|
| Espace de nom | Pascal | namespace System.Security { ... } |
| Type | Pascal | public class StreamReader { ... } |
| Interface | Pascal | public interface IEnumerable { ... } |
| Méthode | Pascal | public class Object { public virtual string ToString(); } |
| Propriété | Pascal | public class String { public int Length { get; } } |
| Evénement | Pascal | . public class Process { public event EventHandler Exited; } |
| Champ | Pascal | public class MessageQueue { public static readonly TimeSpan InfiniteTimeout; }. public struct UInt32 { public const Min = 0; } |
| Valeur numérique | Pascal | public enum FileMode { Append, .... } |
| Paramètre | Camel | public class Convert { public static int ToInt32(string value); } |
Capitalisation des mots composés et des termes courants
La plupart des termes composés sont traités comme des mots simples aux fins de la capitalisation.
❌ NE PAS mettre de majuscule à chaque mot dans les mots composés dits à forme fermée.
Ce sont des mots composés écrits comme un seul mot, comme endpoint. Pour les besoins des directives de mise en majuscule, traitez un mot composé de forme fermée comme un seul mot. Utilisez un dictionnaire courant pour déterminer si un mot composé est écrit sous forme fermée.
| Pascal | Camel | Non |
|---|---|---|
BitFlag |
bitFlag |
Bitflag |
Callback |
callback |
CallBack |
Canceled |
canceled |
Cancelled |
DoNot |
doNot |
Don't |
Email |
email |
EMail |
Endpoint |
endpoint |
EndPoint |
FileName |
fileName |
Filename |
Gridline |
gridline |
GridLine |
Hashtable |
hashtable |
HashTable |
Id |
id |
ID |
Indexes |
indexes |
Indices |
LogOff |
logOff |
LogOut |
LogOn |
logOn |
LogIn |
Metadata |
metadata |
MetaData, metaData |
Multipanel |
multipanel |
MultiPanel |
Multiview |
multiview |
MultiView |
Namespace |
namespace |
NameSpace |
Ok |
ok |
OK |
Pi |
pi |
PI |
Placeholder |
placeholder |
PlaceHolder |
SignIn |
signIn |
SignOn |
SignOut |
signOut |
SignOff |
UserName |
userName |
Username |
WhiteSpace |
whiteSpace |
Whitespace |
Writable |
writable |
Writeable |
Sensibilité à la casse
Les langages qui peuvent s’exécuter sur le CLR ne sont pas tenus de prendre en charge la sensibilité à la casse-.sensibilité à la casse, bien que certains le fassent. Même si votre langage la prend en charge, les autres langages qui pourraient accéder à votre framework ne le font pas. Toute API accessible de l’extérieur ne peut donc pas s’appuyer sur la casse seule pour distinguer deux noms dans le même contexte.
❌ NE PAS supposer que tous les langages de programmation sont sensibles à la casse. Ils ne le sont pas. Les noms ne peuvent pas différer uniquement par la casse.
Portions © 2005, 2009 Microsoft Corporation. Tous droits réservés.
Réimprimé avec l’autorisation de Pearson Education, Inc. à partir de Framework Design Guidelines : Conventions, idiomes et modèles pour les bibliothèques .NET réutilisables, 2e édition par Krzysztof Cwalina et Brad Abrams, publié le 22 octobre 2008 par Addison-Wesley Professional dans le cadre de la série Microsoft Windows Development.
Voir aussi
- Les directives de conception des cadres
- Les directives de nommage
.