Wie man eine Variable benennt, wenn das Wort sowohl ein Substantiv als auch ein Verb ist

Ich habe ein Eckfallproblem mit der allgemeinen Anleitung von:

• Substantive für Variablen
• Verben für Funktionen

Insbesondere habe ich einen Fall, in dem das Wort mehrdeutig ist - es kann entweder ein Verb oder ein Substantiv sein. In einigen Fällen wird die Anwendung im selben Satz in beide Richtungen verwendet .

Ich möchte sicherstellen, dass das Programm auch für zukünftige Entwickler und mich selbst lesbar bleibt, wenn ich Monate später zu Codeabschnitten zurückkehre.

Eines der Beispiele ist mit a battery. A batteryhat eine chargeund man kann auch charge()eine Batterie.

Ich denke, dass beides zu haben Battery.Chargeund Battery.Charge(value)für zukünftige Entwickler verwirrend sein wird.

Meine derzeitige Lösung besteht darin, einfach ein anderes Wort für einen oder beide dieser Fälle (die Variable und die Funktion) auszuwählen. Mein Problem bei diesem Ansatz ist, dass die BatteryVariable und Funktion des Objekts chargenicht mit den Designdiskussionen übereinstimmt , an denen das Objekt beteiligt ist Battery.

Meine Frage ist, ob es einen anderen / besseren Weg gibt, um mit diesem Konflikt in der Namenskonvention umzugehen.

Einige zusätzliche Lektüre zu diesem Thema. Keiner ging wirklich auf das Besondere meiner Frage ein.

• Aussagekräftige Richtlinien für die Benennung von Methoden
• Namenskonventionen für Variablen
• Die ausgewählte Antwort von https://softwareengineering.stackexchange.com/questions/14169/what-naming-guidelines-do-you-follow

In ähnlichen Situationen versuche ich Synonyme zu finden. In diesem Fall würde ich "recharge" für das Verb verwenden. Das "Re" ist etwas überflüssig, aber die Bedeutung ist klar. Die Verwendung der einfachen "Ladung" für die verbleibende Ladung in der Batterie ist nicht eindeutig, da sie keine physikalischen Einheiten angibt. Ich würde "availableAmpHours", "hoursUntilRecharge" oder ähnliches bevorzugen. Die Einheiten hängen davon ab, was für die Anwendung geeignet ist.

Meine persönliche Präferenz ist es, Verben nur für Funktionen zu verwenden, die ihren Zustand ändern. Ich benutze Substantive für nicht mutierende Funktionen. Ich nehme an, es hängt von Ihrer Sicht ab. Auf der Maschinenebene tun nicht mutierende Funktionen etwas, auf der Modellebene jedoch nicht.

Wirf das einfach raus, aber vielleicht besteht die Lösung für diese Instanz der Mehrdeutigkeit darin, diese Funktionalität vollständig aus der Batterie zu entfernen. Ich habe noch nie einen Akku gesehen, der sich selbst auflädt, und es wäre für mich sinnvoller, eine BatteryCharger-Klasse zu haben. Dies würde dazu beitragen, Ihre Bedenken stärker zu entkoppeln und die Aktion deutlicher zu machen.

battery.Charge(50) vs batteryCharger.Charge(battery, 50)

Für mich ist das zweite Formular viel verständlicher und speichert Ihren gesamten "Lade" -Code an einem Ort, anstatt ihn über alle Batterieklassen zu streuen.

Vermeiden Sie doppelte Bedeutungen

Sie haben absichtlich ein Wort ausgewählt, das mehr als eine Bedeutung hat, und diese erste Entscheidung ist das Problem. Es gibt eine Menge Wörter, die für Programmierer problematisch sind. Ein anderes Beispiel wäre phone. Sie können phonejemanden, oder Sie könnten eine phonein der Tasche haben.

Verwenden Sie Getter und Setter

Die Standardbenennung für die meisten Objekte sind die Get- / Einstellungsmethoden für Eigenschaften.

Battery.Charge            // would be a property
Battery.setCharge(value)  // would set the property
Battery.getCharge()       // would get the property

Eigenschaften sind Zustände, nicht Substantive

Ich glaube, Sie täuschen sich, wenn Sie Objekteigenschaften als Substantive klassifizieren, und Variablen könnten auch als Zustände betrachtet werden. Sie sind Staaten, die für den lokalen Geltungsbereich ihrer Existenz relevant sind.

Sie könnten den Wert, den sie haben, als Substantiv beschreiben, aber ich bin mir nicht sicher, ob dies in allen Fällen zutrifft.

In der OOP-Terminologie beschreiben Objekteigenschaften den Status dieses Objekts. In Ihrem Fall Batteryist das ein Objekt und es Chargeist ein Zustand. Das wäre also eine Eigenschaft des Objekts, aber dies hängt vom Kontext ab, in dem es verwendet wird.

Wenn Sie in der Lage sein müssen, Chargedie Batterie und auch wissen, was es aktuell Chargeist, dann haben Sie ein Problem.

Verwenden des Bereichs zum Erzwingen des Kontexts

Der Kontext verdeutlicht, welche Bedeutung eines Wortes Sie mit einer Methode oder Eigenschaft vermitteln möchten. Der Bereich legt die Zugänglichkeit einer Eigenschaft / Methode von außerhalb des Objekts fest.

Batter._charge            // a hidden private property
Battery.setCharge(value)  // would set the private property
Battery.getCharge()       // would get the private property
Battery.Charge()          // would perform the Charge action

Methoden sind Verben

Sie können die Methode eines Objekts als Verb beschreiben, aber das Wort Aktion ist besser geeignet. In der OOP-Terminologie führen Sie Aktionen für Objekte mithilfe ihrer Methoden aus. Es ist eine schlechte Form, die Eigenschaft eines Objekts von außerhalb des Objekts zu ändern. Es wird empfohlen, eine Methode aufzurufen, die die erforderlichen Aktionen ausführt, durch die sich der Status ändert.

Das Wort Chargeist ein Verb, aber es ist auch ein Substantiv. Beim Aufruf der Methode einer Aktion wird deutlich, dass das Verb verwendet wird Battery.Charge(....).

Der Kontext ist jedoch sehr wichtig. Das Wort Charge()ist zwar ein Verb, aber nicht so aussagekräftig wie startCharging().

Gültige Methoden Batterykönnten Charging, Discharging, setCharge, getCharge, hasCharge, Dischargeund Charged.

Einfache Ein-Wort-Methoden geben ihre Handlungen oft nicht explizit an, aber es gibt Fälle wie openund in closedenen wenig Erklärung erforderlich ist.

Es gibt also keine richtige Antwort darauf, wie diese Arten von Eigenschaften / Methoden benannt werden sollen. Mit der Ausnahme, dass Sie die oben genannten Techniken mit Bedacht anwenden müssen, um sicherzustellen, dass keine Verwirrung herrscht.

Stellen Sie ihnen Verben voran, die sie zu einem Verb oder Substantiv machen.

Battery.doCharge()

Battery.getCharge()

Für den Verbfall halte ich das für ChargeOK. Für den Nomenfall würde getCurrentChargeLevelfür Sie arbeiten?

In den meisten Fällen ist das Hinzufügen eines Hilfsverbs, Adverbs oder Adjektivs gut genug, um sie zu unterscheiden, und kann tatsächlich zum Verständnis beitragen. Wenn Sie Charge and Charge () bei einem Akku verwenden, kann DeltaCharge () zeigen, dass es sich um eine Funktion handelt, die sowohl das Laden als auch das Entladen ermöglicht.

Delta (in Fällen, in denen es eine Änderung gibt, die aber nicht eindeutig ist) ist ein Modifikator, den ich immer wieder verwende und anderen empfehle, um Zustandsänderungen zu behandeln (auch wenn das Verb halb offensichtlich ist).

Ungarische Bezeichnung zur Rettung. Sie können intChargeund haben fcnCharge(value), um Verwirrung zu vermeiden und keinen verrückten langen Namen hinzuzufügen, wenn drei Buchstaben gut funktionieren.

Oder Sie könnten einfach den gleichen Namen verwenden und die IDE damit umgehen lassen. Das Erstellen eines längeren oder anderen Namens kann auf lange Sicht sowieso genauso verwirrend sein.