Les acronymes de l'enveloppe du chameau ?

Question

Cette question peut sembler pédante ou simplement stupide, mais quelle est votre pratique en matière de casse des acronymes ? Insistez-vous pour que tout, même les acronymes, soit mis en majuscules, ou faites-vous une exception pour les acronymes ? Des explications seraient également les bienvenues. Je ne suis pas sûr de l'impact de cette pratique sur les fonctionnalités de l'IDE (autocomplétion) ni de la norme industrielle en la matière.

Answer 1

Pour C#, consultez Les directives de Microsoft :

Mettez la majuscule aux deux caractères des acronymes à deux caractères, sauf au premier. premier mot d'un identifiant en identifiant.

Une propriété nommée DBRate est un exemple d'un acronyme court (DB) utilisé comme le premier mot d'un identifiant en Pascal d'un identifiant en Pascal. Un paramètre nommé ioChannel est un exemple de l'acronyme court acronyme (IO) utilisé comme premier mot d'un identifiant d'un identifiant en majuscules.

Ne mettez la majuscule qu'au premier caractère des acronymes de trois caractères ou plus. caractères ou plus, à l'exception du premier mot d'un identifiant en majuscule.

Une classe nommée XmlWriter est un exemple d'un long acronyme utilisé comme premier mot d'un identifiant en pascal. A paramètre nommé htmlReader est un exemple d'un long acronyme utilisé comme le premier mot d'un identifiant en camel.

Ne mettez pas de majuscule aux caractères des acronymes, quelle que soit leur longueur, au début d'un document. leur longueur, au début d'un identifiant en majuscule.

Un paramètre nommé xmlStream est un exemple de exemple d'un long acronyme (xml) utilisé comme le premier mot d'un identificateur identifiant. Un paramètre nommé dbServerName est un exemple de l'acronyme court acronyme court (db) utilisé comme premier mot d'un mot d'un identificateur en majuscules.

Answer 2

Préférence personnelle.

J'ai tendance à le faire juste parce qu'il ne se marie pas bien avec d'autres mots, comme, XMLHTTPParser par rapport à XmlHttpParser . Faites ce qui vous fait plaisir, mais faites-le de manière standard.

Answer 3

Voici ce que j'aime, et c'est pour Java : les classes commencent par une majuscule, les champs par une minuscule, et les acronymes n'ont aucune incidence. Cela conduit à des choses qui ressemblent à ceci,

UrlConnection urlConnection;

Le problème est que si vous essayez d'appliquer une règle selon laquelle il faut toujours mettre les acronymes en majuscules, ou même la première lettre d'un acronyme, qu'il s'agisse d'un champ ou d'un nom de classe, vous obtenez des résultats étranges tels que,

URLConnection URLConnection; // huh?

En d'autres termes, la règle du champ commençant par une minuscule est en contradiction avec une hypothétique règle de l'acronyme en majuscule. Vous ne pouvez pas appliquer les deux.

Même le SDK de Java contient des exemples des deux, dans un seul nom de classe : HttpURLConnection . On pourrait penser que c'est soit HTTPURLConnection o HttpUrlConnection .

Answer 4

Nous n'avons pas de règle stricte, mais nous ne mettons généralement pas les acronymes en majuscules. Quelques-uns avec plus de trois lettres le sont, mais la plupart ne le sont pas.

Answer 5

En général, nos acronymes sont en PascalCased ou en camelCased comme la plupart l'ont indiqué.

Quelques exceptions :

• Si un acronyme utilisé dans le nom d'un membre est bien connu dans l'entreprise pour laquelle le logiciel est écrit, et qu'il s'agit d'un véritable acronyme (les lettres majuscules forment un mot du dictionnaire, par opposition à un simple sigle comme XML), nous lui mettons souvent une majuscule pour éviter toute confusion avec le mot du dictionnaire.

• Parfois, dans les ORM travaillant avec des bases de données existantes, j'ai simplement nommé la variable mappée de la même manière que la colonne de la base de données, avec les majuscules et tout, plutôt que de devoir mapper FdicId => FDICID explicitement dans une base de données sensible à la casse. Cela a ses inconvénients, car les futurs développeurs peuvent silencieusement casser une fonctionnalité s'ils pensent plus fortement que moi qu'elle devrait être correctement casée, mais ne savent pas pourquoi.

• ID est un peu une volte-face lorsqu'il est utilisé à la fin du nom d'un membre. Que ce soit ID ou Id dépend du développeur qui écrit le premier membre de ce type dans une classe ou un espace de nom, et ils sont rarement révisés.