Wie benenne ich etwas, wenn die logische Option ein reserviertes Schlüsselwort ist? [geschlossen]

Gelegentlich ist der logischste Name für etwas (z. B. eine Variable) ein reserviertes Schlüsselwort in der Sprache oder Umgebung Ihrer Wahl. Wenn es kein gleichwertiges Synonym gibt, wie nennt man es?

Ich stelle mir vor, es gibt Best-Practice-Heuristiken für dieses Problem. Diese können von den Erstellern oder Verwaltern von Programmiersprachen und -umgebungen bereitgestellt werden. Wenn zum Beispiel python.org (oder Guido van Rossum) sagt, wie man damit in Python umgeht, wäre das eine gute Richtlinie in meinem Buch. Ein MSDN-Link zum Umgang in C # wäre ebenfalls gut.
Alternativ sollten auch die Richtlinien wichtiger Einflussnehmer in der Softwareentwicklung von Nutzen sein. Vielleicht hat Google / Alphabet einen netten Styleguide, der uns den Umgang damit lehrt?

Hier ist nur ein Beispiel: In der C # -Sprache ist "default" ein reserviertes Schlüsselwort. Wenn ich eine Aufzählung verwende, möchte ich möglicherweise den Standardwert "default" (analog zu "switch" -Anweisungen) angeben, kann dies jedoch nicht.
(C # unterscheidet zwischen Groß- und Kleinschreibung, und Aufzählungskonstanten sollten
großgeschrieben werden. Daher ist "Standard" die naheliegende Wahl. Nehmen wir jedoch an, dass in unserer aktuellen Stilrichtlinie alle Aufzählungskonstanten in Kleinbuchstaben angegeben sind.) Wir könnten das Wort "defaultus" in Betracht ziehen ", aber dies entspricht nicht dem Grundsatz des geringsten Erstaunens . Wir sollten auch "standard" und "initial" berücksichtigen, aber leider ist "default" das Wort, das genau seinen Zweck in dieser Situation wiedergibt.

Für eine Aufzählungsoption sollten Sie die Groß- und Kleinschreibung verwenden Default. Da bei C # die Groß- und Kleinschreibung beachtet wird, kollidiert es nicht mit dem reservierten Schlüsselwort. Siehe .net-Benennungsrichtlinien .

Da alle öffentlichen Mitglieder in .net in Groß- und Kleinschreibung geschrieben sein sollten und alle reservierten Namen in Kleinschreibung geschrieben sind, sollte dies nur bei lokalen Variablen (einschließlich Parametern) auftreten. Und Einheimische haben normalerweise Substantive oder Phrasen als Namen, so dass es ziemlich selten vorkommt, dass der natürlichste Name mit einem Schlüsselwort kollidiert. Z.B. defaultValuewäre in der Regel ein natürlicherer Name als default. In der Praxis ist dies also kein großes Problem.

In C # können Sie das @Präfix " " verwenden, um reservierte Schlüsselwörter zu " " entziehen und sie als Bezeichner (wie @default) zu verwenden. Dies sollte jedoch nur verwendet werden, wenn Sie wirklich keine andere Option haben, dh wenn Sie eine Schnittstelle zu einer Drittanbieter-Bibliothek herstellen, die reservierte Schlüsselwörter als Bezeichner verwendet.

Natürlich haben andere Sprachen andere Syntax und Schlüsselwörter und daher unterschiedliche Lösungen für dieses Problem.

SQL hat eine ganze Reihe von Schlüsselwörtern, aber es ist sehr üblich, Bezeichner wie einfach zu maskieren [Table]. Einige tun dies sogar für alle Bezeichner, unabhängig davon, ob sie mit einem Schlüsselwort in Konflikt stehen oder nicht. (Immerhin könnte in Zukunft ein zusammenstoßendes Schlüsselwort eingeführt werden!)

Powershell (und eine Reihe anderer Skriptsprachen) stellt allen Variablen ein Siegel wie $ voran, was bedeutet, dass sie niemals mit Schlüsselwörtern kollidieren.

Lisp hat überhaupt keine Schlüsselwörter, zumindest nicht im herkömmlichen Sinne.

Python hat in PEP-8 eine offiziell anerkannte Konvention :

Verwenden Sie immer cls als erstes Argument für Klassenmethoden.

Wenn der Name eines Funktionsarguments mit einem reservierten Schlüsselwort in Konflikt steht, ist es im Allgemeinen besser, einen einzelnen nachgestellten Unterstrich anzufügen, als eine Abkürzung oder eine Rechtschreibkorruption zu verwenden. Daher ist class_ besser als clss. (Vielleicht ist es besser, solche Konflikte mit einem Synonym zu vermeiden.)

Einige Sprachen wie Brainfuck oder Whitespace vermeiden die Definition von Wörtern und umgehen das Problem auf elegante Weise.

Kurz gesagt, es gibt keine sprachunabhängige Antwort auf Ihre Frage, da diese stark von der Syntax und den Konventionen der jeweiligen Sprache abhängt.

Ich würde einen Unterstrich anhängen (default_)

Vorteile:

• einfach
• offensichtlich (warum sollten Sie sonst einen Unterstrich anhängen?)
• konsistent
• Einfach zu verwenden
• funktioniert in allen modernen Sprachen, die ich kenne
• der logischen Option am nächsten

Warum ich andere Lösungen nicht mag:

Synonym:

• schwer zu finden
• oft nicht die exakt gleiche Bedeutung (Nuancen)

Wort anhängen / voranstellen:

• inkonsistent (defaultValue, defaultItem)
• erhöhte Ausführlichkeit ohne erhöhte Lesbarkeit

Buchstaben ändern (klausel statt klasse):

• inkonsistent (clazz, klass, klazz)

Nummer anhängen (default1):

• wirft die Frage nach default2 auf

Brief anhängen / voranstellen:

• nicht offensichtlich (Programmierer muss erraten, dass es für die Namenskollision verwendet wurde und keine Abkürzung für etwas anderes)

Schlüsselwort maskieren (@default (c #), `default` (scala))

• nur in einigen Sprachen möglich
• selten genutzte Funktion, hauptsächlich aus Gründen der Kompatibilität mit anderen Sprachen
• erschwert die Verwendung für Benutzer Ihrer API (sie müssen wissen, wie es geht, und sich daran erinnern, wie es geht)

Wann würde ich es nicht benutzen:

• bestehende, weit verbreitete andere Konvention
• Ich kenne bereits ein passendes Synonym
• in deinem speziellen enum Fall würde ich @JacquesB antworten

"Standard" ist wahrscheinlich kein hilfreicher Aufzählungswert. Es stellt ein Verhalten dar, das sich je nach Kontext, in dem es verwendet wird, ändern kann.

Wenn Ihre Sprache zwischen Groß- und Kleinschreibung unterscheidet, verwenden Sie eine andere Groß- und Kleinschreibung für das Wort. (Standard gegen Standard)

Oder noch besser: Geben Sie ein paar Buchstaben mehr ein und nennen Sie es DefaultValue.

Ich würde wärmstens empfehlen, die Namenskonvention NICHT lokal zu ändern (oder bedeutungslose Zeichen hinzuzufügen), um die Mehrdeutigkeit zu verbessern (wie in anderen Posts vorgeschlagen). Es schafft Verwirrung, wenn die Absicht nicht offensichtlich ist, und kann Fragen aufwerfen, warum sie so benannt wurde. Es kann ohne es gelöst werden.

In jedem Fall sollte es möglich sein, entweder ein Wort mit synonymer Bedeutung zu verwenden oder den Namen spezifischer (oder sogar ausführlicher) zu machen. Auch wenn es zu einer Wiederholung des Kontexts kommen kann, ist es möglicherweise eine bessere Lösung.

Nehmen wir beispielsweise an, Sie haben eine Aufzählung Mode, die einen Standardwert wie in Ihrem Fall verfügbar machen soll. Die Benennung default_modescheint aufgrund der Wiederholung nicht die beste zu sein, vermeidet jedoch Mehrdeutigkeiten, während die gewünschte Bedeutung vermittelt wird.

Sie müssen andere oder geänderte Wörter verwenden, das ist klar.
Das bedeutet also normalerweise entweder

• ein ganz anderes wort
• ein Präfix
• ein Suffix

Ein weiterer zu bestimmender Faktor ist die Art und Weise, wie die verschiedenen Wörter verbunden werden

• alleEinwortnoseparatoren
• wörter_mit_unterstrichenen-oder- strichen ( snake_case )
• CapitalizationForClarityAndReadability ( CamelCase )

Mein Vorschlag ist, ein Präfix oder Suffix und Unterstriche / Bindestriche zu verwenden, z

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

local_defaulthat den Vorteil, dass alle Einheimischen ausgerichtet sind und somit schnell auffallen, aber den Nachteil, dass man immer zum zweiten Teil weiterlesen muss, um den eindeutigen Namen zu erhalten. default_localhat den umgekehrten Vorteil, dass der eindeutige Variablenname schnell erkannt wird, die Einheimischen jedoch nicht immer so einfach visuell gruppiert werden können.

Ein paar Beispiele für den domain_spezifischen Ansatz, den ich gesehen habe, sind: vehicle_modelStatt modeldessen war ein reserviertes Wort; room_tablefür eine SQL-Tabelle wie tableein reserviertes Wort.

Die anderen beiden Optionen, die ich bei der Verwendung von Sprachen oder Skripten gesehen habe, sind:

• Anführungszeichen oder Backtips, um Variablennamen zu umgeben und damit die Verwendung reservierter Wörter zu ermöglichen. Ähnlich könnte ich mir vorstellen, dass in einigen Sprachen ein Sonderzeichen wie ein Backspace einem Namen entgehen kann.
• Leerzeichen in Variablennamen.

Tun Sie natürlich, was Sie können, um diese Situation zu vermeiden. Ich schreibe seit den späten 1970er Jahren Software und die Zeit, in der ich wirklich, wirklich ein reserviertes Wort fummeln musste, ist weit unter zehn, wahrscheinlich näher an fünf.

Sie können viele Dinge tun, z. B. den ersten oder letzten Buchstaben verdoppeln ( reservedd) oder einen führenden oder nachfolgenden Unterstrich hinzufügen ( reserved_). Was angemessen ist, hängt stark von den verwendeten Konventionen ab, die Sie schreiben, insbesondere im Hinblick auf führende oder nachfolgende Unterstriche. Versuchen Sie auch, Dinge nicht mit Fällen zu tun, die von Menschen falsch verstanden werden könnten (z. B. mit, Reservedwenn sie von denen abweichen reserved).

Sobald Sie etwas ausgewählt haben, fügen Sie es in Ihre Kodierungsrichtlinien ein, und stellen Sie sicher, dass die Leute darüber Bescheid wissen und dass es konsequent verwendet wird. Ich gehe sogar so weit, einen Erinnerungskommentar hinzuzufügen, damit die Leser nicht glauben, dass es sich um einen Tippfehler handelt, und wissen, dass sie ihn wieder sehen werden:

int ccase;  // Name dodges a reserved word

In C # können Sie dem Namen eines Bezeichners ein @ voranstellen . Dies weist den Compiler an, den Namen als Namen einer Kennung und nicht als mögliches Schlüsselwort zu behandeln.

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