Comment nommer quelque chose lorsque l'option logique est un mot clé réservé? [fermé]

Parfois, le nom le plus logique pour quelque chose (par exemple une variable) est un mot clé réservé dans la langue ou l'environnement de votre choix. Quand il n'y a pas de synonyme tout aussi approprié, comment peut-on l'appeler?

J'imagine qu'il existe des heuristiques de meilleures pratiques pour résoudre ce problème. Ceux-ci pourraient être fournis par les créateurs ou les gouverneurs des langages de programmation et des environnements. Par exemple, si python.org (ou Guido van Rossum) explique comment le gérer en Python, ce serait une bonne directive dans mon livre. Un lien MSDN sur la façon de gérer cela en C # serait également utile.
Alternativement, les directives fournies par les principaux influenceurs en génie logiciel devraient également être utiles. Peut-être que Google / Alphabet a un bon guide de style qui nous apprend comment le gérer?

Voici un exemple: dans le langage C #, "default" est un mot clé réservé. Lorsque j’utilise une énumération, j’aimerais peut-être nommer la valeur par défaut "default" (analogue aux instructions "switch"), mais ne le peut pas.
(C # est sensible à la casse et les constantes enum devraient être en majuscules. Le choix par défaut est donc évident, mais supposons que notre guide de style actuel dicte que toutes les constantes enum doivent être en minuscules.)
Nous pourrions considérer le mot "defaultus". ", mais cela n’adhère pas au principe de moindre surprise . Nous devrions également considérer «standard» et «initial», mais malheureusement, «défaut» est le mot qui traduit exactement son objectif dans cette situation.

Pour une option enum, vous devriez utiliser un cas de titre comme Default. C # étant sensible à la casse, il n'entrera pas en conflit avec le mot clé réservé. Voir les directives de nommage .net .

Étant donné que tous les membres publics doivent avoir la casse du titre dans .net et que tous les noms réservés sont en minuscule, vous ne devriez pas le rencontrer, sauf avec des variables locales (y compris des paramètres). Et les habitants ont généralement des noms ou des phrases comme noms, il est donc assez rare que le nom le plus naturel entre en collision avec un mot-clé. Par exemple. defaultValueserait généralement un nom plus naturel que default. Donc, dans la pratique, ce n’est pas un gros problème.

En C #, vous pouvez utiliser le @préfixe " " pour échapper aux mots clés réservés afin qu'ils puissent être utilisés comme identifiants (du type @default). Mais cela ne devrait être utilisé que si vous n'avez vraiment aucune autre option, c'est-à-dire si vous vous connectez à une bibliothèque tierce qui utilise un mot clé réservé comme identifiant.

Bien sûr, d'autres langues ont une syntaxe et des mots-clés différents et, par conséquent, différentes solutions à ce problème.

SQL a beaucoup de mots-clés, mais il est très courant d'échapper simplement aux identifiants, comme [Table]. Certains le font même pour tous les identifiants, qu'ils entrent en conflit avec un mot clé ou non. (Après tout, un mot clé conflictuel pourrait être introduit à l'avenir!)

Powershell (et de nombreux autres langages de script) préfixe toutes les variables avec un sigil comme $, ce qui signifie qu'elles n'entreront jamais en conflit avec des mots-clés.

Lisp n'a pas du tout de mots clés, du moins pas au sens conventionnel du terme.

Python a une convention officiellement reconnue dans PEP-8 :

Toujours utiliser cls pour le premier argument des méthodes de classe.

Si le nom d'un argument de fonction entre en conflit avec un mot clé réservé, il est généralement préférable d'ajouter un seul soulignement de fin de phrase plutôt que d'utiliser une abréviation ou une corruption de l'orthographe. Ainsi, class_ est meilleur que clss. (Mieux vaut peut-être éviter de tels affrontements en utilisant un synonyme.)

Certaines langues telles que Brainfuck ou Whitespace évitent de définir des mots, évitant élégamment le problème.

En bref, il n’ya pas de réponse indépendante de la langue à votre question, car elle dépend fortement de la syntaxe et des conventions de la langue spécifique.

Je voudrais ajouter un trait de soulignement (default_)

Avantages:

• Facile
• évident (sinon pourquoi ajouteriez-vous un trait de soulignement?)
• cohérent
• facile à utiliser
• fonctionne dans toutes les langues modernes que je connais
• plus proche de l'option logique

Pourquoi je n'aime pas les autres solutions:

Synonyme:

• difficile à trouver
• souvent pas exactement la même signification (nuances)

Ajouter / Préposer un mot:

• incohérent (defaultValue, defaultItem)
• verbosité accrue sans lisibilité accrue

Changer les lettres (clazz au lieu de la classe):

• incohérent (clazz, klass, klazz)

Ajouter un numéro (par défaut1):

• soulève la question de default2

Ajouter / ajouter une lettre au préalable:

• non évident (le programmeur doit deviner qu'il a été utilisé pour namecollision et non comme raccourci pour autre chose)

Échapper à un mot-clé (@default (c #), `default` (scala))

• seulement possible dans certaines langues
• fonctionnalité rarement utilisée, principalement pour la compatibilité avec d'autres langues
• rend plus difficile l'utilisation pour les utilisateurs de votre API (ils doivent savoir comment le faire et se rappeler comment le faire)

Quand ne l'utiliserais-je pas:

• convention existante, largement utilisée
• Je connais déjà un synonyme approprié
• dans votre cas spécifique, je suivrais la réponse de @JacquesB

"Default" n'est probablement pas une valeur utile enum. Cela représente un comportement qui peut changer en fonction du contexte dans lequel il est utilisé.

Cela étant dit, si votre langue est sensible à la casse, utilisez une casse différente pour le mot. (Valeur par défaut vs valeur par défaut)

Ou mieux encore, faites l'effort supplémentaire de taper quelques lettres de plus et appelez-le DefaultValue.

Je recommanderais vivement de NE PAS modifier localement la convention de dénomination (ni ajouter des caractères dénués de sens) aux fins de la désambiguïsation (comme cela a été suggéré dans d'autres messages). Cela crée de la confusion si l'intention n'est pas évidente et peut amener à se demander pourquoi il a été nommé ainsi. Il peut être résolu sans cela.

Dans tous les cas, il devrait être possible d'utiliser un mot ayant une signification synonyme ou de préciser le nom (ou même de le commenter). Même si cela introduit une répétition du contexte, cela peut être une meilleure solution.

Par exemple, disons que vous avez une énumération Modequi devrait exposer une valeur par défaut, comme dans votre cas. Nommer cela default_modepeut ne pas sembler le meilleur en raison de la répétition, mais cela évite les ambiguïtés tout en transmettant le sens souhaité.

Vous devrez utiliser des mots différents ou modifiés, cela est clair.
Donc, cela signifie généralement soit

• un mot complètement différent
• un préfixe
• un suffixe

Un autre facteur à déterminer est la manière de joindre les mots multiples et les options sont généralement

• allonewordnoseparators
• words_with_underscores-or- dash ( snake_case )
• CapitalisationForClarityAndReadability ( CamelCase )

Ma suggestion est d’utiliser un préfixe ou un suffixe et des traits de soulignement / tirets, par exemple

local_default, my_default, a_default, domain_specific_default
default_local, default_me, default_a, default_domain_specific

local_defaultL'avantage est que toutes les sections locales sont alignées et se démarquent donc rapidement, mais l'inconvénient est que vous devez toujours lire la deuxième partie pour obtenir le nom unique. default_localL’avantage commun est que le nom unique de la variable est rapidement visible, mais les sections locales ne sont pas toujours aussi facilement regroupées visuellement.

Voici quelques exemples de l’approche domain_specific que j’ai vue: vehicle_modelau lieu de modelqui était un mot réservé; room_tablepour une table SQL comme tablec'est un mot réservé.

Les deux autres options que j'ai vu utiliser des langues ou des scripts sont:

• guillemets ou backtips pour entourer les noms des variables et permettre ainsi l’utilisation de mots réservés. De même, je pourrais imaginer que certaines langues permettraient à un caractère spécial, tel qu'un retour arrière, d'échapper à un nom.
• espaces dans les noms de variables.

Évidemment, faites ce que vous pouvez pour éviter cette situation. J'écris des logiciels depuis la fin des années 1970 et le temps où j'ai vraiment dû tromper un mot réservé est bien inférieur à dix, probablement plus proche de cinq.

Vous pouvez faire beaucoup de choses, comme doubler la première ou la dernière lettre ( reservedd) ou ajouter un trait de soulignement ( reserved_). Ce qui est approprié dépendra beaucoup du langage utilisé dans les conventions, en particulier en ce qui concerne les traits de soulignement. Essayez également de ne pas faire des choses avec des cas qui pourraient être mal interprétés par les humains (par exemple, en utilisant Reservedquand il diffère de reserved).

Une fois que vous avez choisi quelque chose, mettez-le dans vos directives de codage, assurez-vous que les gens le savent et qu'il est utilisé de manière cohérente. Je vais même jusqu'à ajouter un commentaire de rappel pour que les lecteurs ne pensent pas que ce soit une faute de frappe et sachent qu'ils le verront encore:

int ccase;  // Name dodges a reserved word

En C #, vous pouvez ajouter le nom d'un identifiant avec @ . Cela indique au compilateur de traiter le nom comme le nom d'un identifiant et non comme un mot clé possible.

enum @default {Sat, Sun, Mon, Tue, Wed, Thu, Fri};