Projekt eStats
Darmowe statystyki odwiedzin
Wskazówki ogólne
W tym artykule zostało zawarte kilka podstawowych zasad, które są stosowane w eStats.
Spis treści
^ Styl kodowania
Zaleca się stosowanie poniższych reguł kodowania w przypadku pisania komponentów dla skryptu:
- [PHP, JS] Klamry ({}) używane są tylko jeśli warunek, pętla lub inne zawierają więcej niż jedną instrukcję, lub użycie klamry podyktowane jest zwiększeniem przejrzystości (np. w celu uniknięcia powstania długich linii kodu);
-
[PHP, JS] Klamry otwierane są w linii warunku lub pętli (jedna spacja odstępu od zamknięcia nawiasu) a jej zamknięcie powinno znajdować się w nowej linii na wysokości otwarcia nawiasu warunku, przykład:
1 2 3 4
if ($Zmienna) { zrob_cos (); zrob_cos_innego (); }
- [PHP, JS] Spacje są stosowane jako odstępy (tabulacje są niezalecane);
-
[PHP, JS] W przypadku elementów dużych tablic używane są tabulacje (każdy element tablicy występuje w nowej linii), pod tablice używają kolejnego poziomu wcięć itd., przykład:
1 2 3 4 5 6 7 8 9 10
$Array = array ( array ( 'wartość', 'wartość' 'klucz' => array ( 'wartość' ) ), 'wartość' );
-
[CSS] Po nazwie selektora używamy spacji, a następnie otwieramy klamrę, każda instrukcja musi być poprzedzona znakiem tabulacji, wewnątrz instrukcji używamy tylko niezbędnych spacji, zamknięcie klamry poprzedzamy znakiem tabulacji, przykład:
1 2 3 4 5
body { min-height:100%; text-align:center; background:url(images/body.png) center repeat-y; }
- [PHP, JS] Nazwy funkcji zapisujemy małymi literami, używamy znaku podkreślenia (_) aby zastąpić spacje (w JS nie używamy tego znaku, a pierwszy znak każdego kolejnego wyrazu używamy dużej litery), nazwy funkcji nie powinny zawierać skrótów;
- [PHP] nazwy funkcji zapisujemy małymi literami, używamy znaku podkreślenia (_) aby zastąpić spacje, nazwy funkcji nie powinny zawierać skrótów;
- [(X)HTML] Każdy ważniejszy znacznik (otwarcie i zamknięcie) powinien znajdować się w nowej linii, kod musi się walidować, a atrybuty powinny być używane w podobnej kolejności;
- [PHP, JS] Komentarze (jeśli są niezbędne) powinny być pisane w języku angielskim (poza tymi w plikach tłumaczeń, tam obowiązuje język tłumaczenia);
- [PHP] W przypadku, gdy nie można załadować niezbędnego pliku lub wykonać niezbędnej operacji, można skorzystać z funkcji e_error_message () aby poinformować użytkownika o błędzie krytycznym;
^ Licencjonowanie
Preferowane formy licencjonowania komponentów (motywy, wtyczki, antypiksele) to GPL, LGPL i inne wolne licencje.
Licencja GPL lub LGPL (lub kompatybilna) jest wymagana dla elementów, które mogłyby stać się częścią głównego skryptu (np. domyślny motyw, tłumaczenia).
^ Inne
Stosować należy wyłącznie kodowanie UTF-8.
Nazwy katalogów i plików nie mogą zawierać spacji oraz znaków spoza angielskiego alfabetu.
Nazwy funkcji, zmiennych, katalogów i plików powinny być zapisane w języku angielskim.
Dla skryptów PHP wymagana jest zgodność z >= 4.3.
Określenie grupa dotyczy poszczególnych tabel danych (np. Języków) w Ogólnych i Technicznych.
Ostatnia modyfikacja: 2008-02-18 22:17:49 CET
Oscar WildeKiedy jesteśmy szczęśliwi, jesteśmy zawsze dobrzy, lecz kiedy jesteśmy dobrzy, nie zawsze jesteśmy szczęśliwi.