Generator nazw zmiennych

Generator nazw zmiennych

Konwencja nazewnictwa to jedna z najważniejszych decyzji w projekcie. Ten sam tekst można zapisać w kilku stylach, zależnie od języka i kontekstu.

Popularne konwencje

Przykład

Tekst „user profile image url” zamienia się w userProfileImageUrl (camelCase), user_profile_image_url (snake_case) czy USER_PROFILE_IMAGE_URL (stała).

Dlaczego to ważne?

• Spójność ułatwia czytanie i wyszukiwanie kodu.
• Konwencje są wymuszane przez lintery i standardy (PSR, PEP 8).
• Właściwy styl zależy od języka i kontekstu.

Jak działa generator nazw zmiennych

Generator działa w trzech etapach: normalizacji, podziale na tokeny i scalaniu według wybranej konwencji. Najpierw pobiera wpisany tekst i porządkuje go tak, aby można było rozpoznać granice słów. Granicami są najczęściej spacje, podkreślenia, myślniki, kropki oraz przejścia z małej litery na wielką. Dzięki temu ciąg taki jak customer order item count staje się listą czterech niezależnych tokenów, a nie jednym napisem.

Po podziale narzędzie odrzuca separatory i zapamiętuje kolejność tokenów. Następnie stosuje regułę wybranej konwencji. W camelCase pierwszy token trafia do wyniku małymi literami, a każdy kolejny zaczyna się wielką literą. W PascalCase wielką literą zaczyna się każdy token. W snake_case i kebab-case wszystkie tokeny są małymi literami, a łączy je stały separator. W CONSTANT_CASE litery są wielkie, a separatorem pozostaje podkreślenie. To transformacja pozycyjna: znaczenie nazwy nie jest analizowane, liczy się tylko liczba i kolejność słów.

W praktyce wynik można opisać prostym wzorem: pierwszy token w wybranej wielkości liter, potem dla każdego następnego tokenu separator właściwy dla konwencji oraz token w wymaganej wielkości liter. Jeśli wejściowy tekst zawiera już camelCase, generator może rozbić go po wielkich literach i potraktować każdy człon jako osobne słowo. Dlatego przed skopiowaniem nazwy warto sprawdzić, czy podział odpowiada intencji, czy nie rozbił utrwalonego akronimu albo nazwy własnej.

Przykład krok po kroku

1. Wpisz tekst: customer order item count. To cztery słowa rozdzielone spacjami, więc po normalizacji powstają cztery tokeny.
2. Narzędzie zapisuje tokeny w kolejności: customer, order, item, count. Liczba tokenów wynosi 4.
3. Dla camelCase pierwszy token zostaje małą literą: customer. Kolejne tokeny zaczynają się wielką literą: Order, Item, Count.
4. Tokeny są scalane bez separatora. Wynik to customerOrderItemCount. Nazwa ma 22 znaki: 8 znaków w customer, 5 w Order, 4 w Item i 5 w Count.
5. Dla snake_case wszystkie tokeny są małymi literami i łączy je podkreślenie. Wynik to customer_order_item_count, czyli 25 znaków, bo do 22 znaków dochodzą 3 podkreślenia.
6. Dla CONSTANT_CASE litery zmieniają się na wielkie, a podkreślenia zostają. Wynik to CUSTOMER_ORDER_ITEM_COUNT, również 25 znaków. Ten sam mechanizm działa dla kebab-case, tylko zamiast podkreśleń pojawiają się myślniki.

Tabela separatorów i granic słów

Praktyczne wskazówki

• Wybierz konwencję języka. W JavaScript i Javie zmienne oraz metody zapisuje się zwykle w camelCase, a klasy w PascalCase. W Pythonie podstawą jest snake_case, natomiast stałe przyjęło się zapisywać w CONSTANT_CASE. Jeśli projekt ma własny standard, on jest ważniejszy od ogólnej zasady.
• Nie mieszaj stylów w jednym pliku. Nawet poprawna nazwa wygląda źle, gdy obok niej pojawia się inny zapis. Ustal regułę dla modułu i stosuj ją konsekwentnie, bo spójność ułatwia wyszukiwanie oraz code review.
• Skracaj świadomie. Zamiast usr lepiej użyć user, jeśli skrót nie jest w projekcie utrwalony. Zbyt krótkie nazwy oszczędzają kilka znaków, ale kosztują czytelność i zwiększają ryzyko pomyłki.
• Unikaj słów nic nieznaczących. Tokeny typu data, value, temp, obj często nie mówią, co zmienna przechowuje. Lepiej nazwać rolę, na przykład invoiceTotal zamiast tempValue.
• Pamiętaj o kontekście. Nazwa nie musi powtarzać nazwy klasy ani modułu. Jeśli funkcja obsługuje koszyk, wystarczy itemCount, a nie shoppingCartItemCount. Krótsza nazwa jest łatwiejsza do czytania, dopóki pozostaje jednoznaczna.

Ograniczenia generatora

• Brak wiedzy o projekcie. Narzędzie nie sprawdza, czy podobna nazwa już istnieje w kodzie ani czy nie koliduje z klasą, funkcją, importem albo zmienną globalną. Kolizje trzeba wykryć w edytorze lub kompilatorze.
• Brak analizy składni języka. Generator nie wie, czy wybrana nazwa nie jest słowem zastrzeżonym w JavaScript, Pythonie, PHP, Javie czy innym języku. Nie sprawdza też wymagań lintera ani standardu typu PSR czy PEP 8.
• Brak tłumaczenia i odmiany. Jeśli wpiszesz słowa w różnych językach albo w liczbie mnogiej, wynik zachowa ten stan. Narzędzie nie poprawia gramatyki, nie dobiera synonimów i nie skraca nazw w sposób świadomy.
• Uproszczona obsługa znaków specjalnych. Polskie znaki, akronimy, cyfry i nietypowe separatory mogą zostać potraktowane inaczej, niż oczekujesz. Po wygenerowaniu nazwy sprawdź, czy nie powstały puste tokeny, podwójne separatory albo człony zaczynające się cyfrą.

Najczęstsze pytania