Konwencje nazewnicze elementów aplikacji

W projektach realizowanych w Eximee Designer stosowanie spójnych konwencji nazewniczych dla elementów aplikacji jest kluczowe dla utrzymania porządku, przejrzystości i efektywnej współpracy w zespole.

Dobrze dobrane nazwy ułatwiają:

• szybkie wyszukiwanie i filtrowanie komponentów w repozytorium,
• rozpoznanie funkcji i przeznaczenia danego elementu bez konieczności jego otwierania,
• unikanie konfliktów nazw i przypadkowego nadpisywania artefaktów,
• zarządzanie dużymi zbiorami formularzy, procesów, skryptów itp., zwłaszcza w środowiskach z wieloma aplikacjami i zespołami.

Poniższa tabela prezentuje zalecane konwencje nazewnicze dla wszystkich głównych typów elementów aplikacji w Eximee. Są one zgodne z dobrymi praktykami stosowanymi w projektach produkcyjnych i umożliwiają zachowanie porządku w skalowalnych rozwiązaniach.

Nazwy należy standardowo tworzyć w języku angielskim. Wyjątek stanowią sytuacje, w których nazwa formularza została określona odgórnie w języku polskim.

Tabela konwencji nazewniczych elementów aplikacji Eximee

Typ elementu	Format nazwy	Przykład
Aplikacja	prefix_app	kontoJunior_app, 800plus_app
Formularz	prefixName	kontoJuniorStart, kontoJuniorForm, kontoJuniorAcceptance
Pozostałe elementy(np. skrypty)	prefixName	kontoJuniorCheckAmount
Procesy	prefixNameProcess	kontoJuniorProcess, kontoJuniorSendNotificationProcess

Zasady ogólne

• prefix - nazwa biznesowa danego projektu, umieszczana na początku każdego elementu aplikacji w formacie camelCase
• Name - nazwa danego elementu w formacie camelCase

W przypadku formularzy i aplikacji należy brać pod uwagę to, że nazwa formularza/aplikacji pojawia się potem m.in. w adresie URL.