Jak nazwać zmienną, gdy słowo jest jednocześnie rzeczownikiem i czasownikiem

Zetknąłem się z problemem związanym z przypadkami narożnymi z ogólnymi wskazówkami:

• rzeczowniki dla zmiennych
• czasowniki dla funkcji

W szczególności mam przypadek, w którym słowo jest dwuznaczne - może to być czasownik lub rzeczownik. W niektórych przypadkach, gdy omawiamy aplikację, będzie ona używana w obie strony w tym samym zdaniu.

Moim celem jest upewnienie się, że program pozostanie czytelny zarówno dla przyszłych programistów, jak i dla mnie, gdy wrócę do części kodu później.

Jednym z przykładów jest battery. A batteryma chargei możesz także charge()baterię.

Myślę, że o obu Battery.Chargei Battery.Charge(value)będzie mylące dla przyszłych programistów.

Moje obecne rozwiązanie to po prostu wybrać inne słowo dla jednego lub obu tych przypadków (zmiennej i funkcji). Mój problem z tym podejściem polega na tym, Batteryże zmienna obiektu i funkcja chargenie są zgodne z dyskusjami projektowymi z udziałem Battery.

Moje pytanie brzmi, czy istnieje inny / lepszy sposób radzenia sobie z tym konfliktem w konwencji nazewnictwa?

Dodatkowe lektury na ten temat. Nikt tak naprawdę nie zajął się szczegółem mojego pytania.

• Znaczące, zwięzłe wytyczne dotyczące nazewnictwa metod
• Konwencje nazewnictwa zmiennych
• Wybrana odpowiedź od https://softwareengineering.stackexchange.com/questions/14169/what-naming-guidelines-do-you-follow

W podobnych sytuacjach staram się znaleźć synonimy. W tym przypadku użyłbym „doładowania” dla czasownika. „Re” jest nieco zbędne, ale znaczenie jest jasne. Użycie prostego „ładowania” dla pozostałego ładunku w akumulatorze jest dwuznaczne, ponieważ nie określa żadnych jednostek fizycznych. Wolałbym „availableAmpHours”, „hoursUntilRecharge” lub coś podobnego. Jednostki będą zależeć od wszystkiego, co jest wygodne dla aplikacji.

Osobiście wolę używać czasowników tylko dla funkcji, które zmieniają stan. Używam rzeczowników do funkcji niemutujących. Przypuszczam, że to zależy od twojego punktu widzenia. Na poziomie maszyny funkcje niemutujące coś robią, ale na poziomie modelu nie.

Po prostu to wyrzucamy, ale być może rozwiązaniem tego niejednoznacznego nazewnictwa jest całkowite usunięcie tej funkcjonalności z baterii. Nigdy nie widziałem samodzielnie ładującej się baterii i dla mnie sensowniejsze byłoby posiadanie klasy BatteryCharger. Pomogłoby to utrzymać Twoje obawy w większym stopniu oddzielone od siebie i uwydatnić działanie.

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

Dla mnie druga forma jest znacznie bardziej zrozumiała i utrzymuje cały kod „Ładowanie” w jednym miejscu, zamiast posypywać go wszystkimi klasami akumulatorów.

Unikaj podwójnego znaczenia

Celowo wybrałeś słowo, które ma więcej niż jedno znaczenie, i ta pierwsza decyzja jest problemem. Istnieje mnóstwo słów, które są problematyczne dla programistów. Innym przykładem może być phone. Możesz phonekogoś lub możesz mieć phonew kieszeni.

Użyj Getters i Setters

Standardowe nazewnictwo większości obiektów to metody pobierające / ustawiające właściwości.

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

Właściwości są stanami, a nie rzeczownikami

Myślę, że mylisz się, klasyfikując właściwości obiektu jako rzeczowniki, a zmienne można również traktować jako stany. Są to stany związane z lokalnym zakresem ich istnienia.

Możesz opisać wartość, którą mają jako rzeczownik, ale nie jestem pewien, czy tak jest we wszystkich przypadkach.

W terminologii OOP właściwości obiektu opisują stan tego obiektu. W twoim przypadku Batteryjest to obiekt i Chargejest stanem. To byłaby właściwość obiektu, ale zależy to od kontekstu jego użycia.

Jeśli musisz być w stanie Chargenaładować baterię, a także wiedzieć, co to jest prąd Charge, masz problem.

Używanie zakresu do wymuszania kontekstu

Kontekst wyjaśnia, jakie znaczenie słowa ma przekazać metoda lub właściwość. Zakres określa ustawienie właściwości / metody spoza obiektu.

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

Metody to czasowniki

Możesz opisać metodę obiektu jako czasownik, ale lepiej nadaje się akcja słowo. W terminologii OOP wykonujesz działania na obiektach przy użyciu ich metod. Zła forma modyfikowania właściwości obiektu spoza obiektu. Preferowane jest wywołanie metody, która wykonuje wymagane działania, które powodują zmianę stanu.

Słowo Chargejest czasownikiem, ale także rzeczownikiem. W przypadku wywołania metody akcji staje się jasne, że czasownik jest używany Battery.Charge(....).

Ale kontekst jest bardzo ważny. Chociaż słowo Charge()jest czasownikiem, nie jest tak znaczące jak startCharging().

Prawidłowe metody Batterymogą obejmować Charging, Discharging, setCharge, getCharge, hasCharge, Dischargei Charged.

Proste metody jedno słowo często nie wyraźnie stwierdzić jasno swoje działania, ale są pewne przypadki, jak openi closegdzie wymagana jest trochę wyjaśnień.

Więc tak naprawdę nie ma poprawnej odpowiedzi na pytanie, jak nazwać tego rodzaju właściwości / metody. Tyle, że musisz mądrze stosować powyższe techniki, aby upewnić się, że nie ma zamieszania.

Przygotuj je czasownikami, które uczynią z nich czasownik lub rzeczownik.

Battery.doCharge()

Battery.getCharge()

W przypadku czasownika myślę, że Chargejest OK. W przypadku rzeczownika, czy getCurrentChargeLevelzadziałałoby dla ciebie?

W większości przypadków dodanie czasownika pomocniczego, przysłówka lub przymiotnika jest wystarczająco dobre, aby je rozróżnić i może pomóc w zrozumieniu. W przypadku Charge i Charge () na akumulatorze DeltaCharge () może pokazywać, że jest to funkcja, która może obsługiwać ładowanie lub rozładowywanie.

Delta (w przypadkach, w których występuje zmiana, ale niejednoznaczna) jest modyfikatorem, którego używam i polecam innym przez cały czas do przekazywania zmiany stanu (nawet jeśli czasownik jest półoczywisty).

Notacja węgierska na ratunek. Możesz mieć intChargei fcnCharge(value), co pozwala uniknąć nieporozumień i nie dodając szalony długą nazwę, kiedy trzy litery będzie działać dobrze.

Lub możesz po prostu użyć tej samej nazwy i pozwolić IDE sobie z tym poradzić. W każdym razie tworzenie dłuższej lub innej nazwy może być równie mylące na dłuższą metę.