Developer Guide [Polish]

Spis treści

• Zasady pisania/utrzymania kodu
• Podział zawartości na pakiety
  • Pakiet główny
  • Pakiet core
    • WasmQueryRegisterLibrary
  • Pakiet shortQuery
  • Pakiet timeQuery
• Nazwy zmiennych
• Template
• Wtyczka

Zasady pisania/utrzymania kodu

• nazwy zmiennych pisane camelCase
• nazwy zmiennych pisane po angielsku
• nad funkcją/zmienną globalną dodajemy komentarz co dana rzecz robi/czym jest.
• jeśli czegoś nie musimy eksportować to tego nie robimy
• pliki nazywamy z prefixem wasmQuery
• funkcje/zmienne eksportowane nazywamy z prefixem WasmQuery
• w przypadku pakietu shortQuery dzielimy funkcjonalności na te zwykłe oraz te forArray. Jeśli dana funkcjonalność jest tylko dla tablic to nie dodajemy do niej forArray
• zmienne w pętlach nazywamy od i w górę
• w przypadku pętli for range używamy jako zmiennych key oraz value. Jeśli te nazwy zakrywają jakąś inną to keyOfIteration oraz valueOfIteration
• tablica zwracana to outputArray
• jedna wartość dla najbardziej zagnieżdżonej iteracji to valueOfIteration
• tablica wartości przy zagnieżdżonych pętlach nosi nazwę arrayForOneValue
• selektor w kodzie zapisujemy pod zmienną o nazwie selector
• wartość w kodzie zapisujemy pod zmienną o nazwie value
• staramy się budować statementy przy użyciu if'ów i return'ów jeśli jest to możliwe aby wyprowadzić jak najkrótszą ścieżkę dla poszczególnego wywołania

Podział zawartości na pakiety

Pakiet główny

W skład tego pakietu wchodzi tylko plik main.go który zawiera funkcję główna. Jest odpowiedzialny za komunikacje z JavaScript'em poprzez channel, wywołanie funkcji inicjalizującej podstawowe wartości dla ustawień, oraz zarejestrowaniu do JavaScript'u globalnej funkcji registerWasmQuery();.

Pakiet core

W skład tego pakietu wchodzą najbardziej podstawowe funkcje związane z rejestrowaniem/wyrejestrowaniem biblioteki. Poza tym pakiet jest związany z zwalnianiem z pamięci pakietów/funkcji oraz zmianą ustawień dla biblioteki.