Standard kodowania PHP

1. Nazewnictwo folderów

Język nazewnictwa: angielski.

Nazwy folderów pochodzą od ich funkcjonalności.

Przykład:

css - przechowuje pliki z rozszerzeniem .css
js - przechowuje pliki z rozszerzeniem .js
images - przechowuje pliki graficzne

2. Nazewnictwo plików

Język nazewnictwa: angielski.

Nazwa pliku może składać się z kilku wyrazów oddzielonych znakiem podkreślenia ('_'). Małe litery, do 32 znaków.

3. Nazewnictwo zmiennych

Język nazewnictwa: angielski.

Następujące typy zmiennych powinny być poprzedzone prefixem:

arr_    array (tablica)
Nazwy:
Nie więcej niż 14 znaków.

SQL:
Nazwy słów kluczowych SQL piszemy dużymi literami:
Przykład:
$str_query = "SELECT * FROM pracownicy";


W nazwach zmiennych używamy TYLKO małych liter.
W nazwach pętli wykorzystawane głównie zmienne pojedyncze np. $i, $j, $k.

4. Nazewnictwo stałych

Język nazewnictwa: angielski.

Stałe piszemy TYLKO i WYŁĄCZNIE dużymi literami. Używamy podkreślnika w celu oddzielenia poszczególnych członów. Brak jakichkolwiek prefiksów.

5. Operatory

Wszystkie operatory (przypisania, logiczne, arytmetyczne..) oddzielane jedną spacją.

Przykład:

$int_a = 5;
$my_str .= "tekst jakis";
if (($name == 'Adik') or ($name == 'Wojtek'))

6. Klamry

Każde pojawianie się instrukcji implikuje wcięcie ciała instrukcji (patrz pkt. 7 ).

Klamra "{" pojawia się w linii zamieszczenia instrukcji, deklaracji funkcji, klasy.

Klamra "}" pojawia się w nowej linii (mając na uwadze wszystkie wcięcia) po zakończeniu ciała instrukcji.

7. Instrukcje

Odzielanie spacją następuje przed i po nawiasach instrukcji.

Przykład:

if ( ) {
for (..; ..; ..) {

Używanie klamer ({ , } ) bez względu na liczbę linii kodu.

Przykład:

if ($int_value == 5) {

   for ($i=0; $i<5;  $i++) {

      if ($x == $i){
         $set[$i] = 1;
      }
   }

Każde pojawianie się instrukcji implikuje wcięcie ciała instrukcji, jak w przykładzie powyżej.

Wielkość wcięcia ustala się na 1 tabulację i nie ma od tego odstępstwa.

Każda instrukcja powinna być poprzedzona pustą linią.

Przykład:

if ($int_value == 5) {

   for ($i=0; $i<5;  $i++) {

      if ($x == $i) {
         $set[$i] = 1;
      }
   }

8. Funkcje

Nazwa funkcji w języku angielskim, małymi literami, oddzielenie wyrazów znakiem "_".

Nazwa funkcji powinna najdobitniej oddawać jej funkcję, należy unikać długich nazw funkcji.

Zaleca się stosowanie czasowników jako nazw funkcji.

Przykład:

do_something () {

Powyższe zalecenia dot. nazw funkcji nie dotyczą tych, które są konstruktami klas.

Przed i po nawiasach deklaracji funkcji pojedyncza spacja.

Przykład:

my_function () {

Argumenty funkcji odzielone przecinkami, po przecinkach pojedyncza spacja.

Klamra rozpoczynająca funkcję ( { ) znajduje się w miejscu deklaracji funkcji.

Przykład:

my_function () {

W wywołaniu funkcji nie wolno używać dodatkowych spacji pomiędzy nazwą funkcji a nawiasami.

Przykład:
my_function (); źle
my_function(); dobrze !

9. Klasy

Nazwa klasy w języku angielskim, odzielenie kolejnych członów nazwy "_". Duże litery muszą występować na początku nazwy oraz przy oddzieleniu poszczególnych wyrazów.

Przykład:
Test_Class

Pliki PHP z nazwami klas dodatkowo zakończone są koncówką ".class". Przykład:

Dla klasy Test_Class plik php ma nazwę: test_class.class.php.

Deklaracja klasy + dziedziczenie.

Przykład:
class Test_Class extends Class {
   var $owner; 

   function set_owner ( $name ) {
      $this->owner = $name;
   }
}

Nazwy funkcji oraz zmiennych wewnątrz klas również pisane są zgodnie z zasadami ustalonymi w punktach 3 oraz 8.

Operator -> nie jest poprzedzany żadnym odstępem (przed i po).

Przykład:
$this->class_variable

10. Komentarze

Obowiązkowe umieszczanie przed deklaracjami funkcji, metod, konstruktorów informacji dot. parametrów wywołania(@param), wartości zwracanej (@return), autora (@author), a także opisu działania danej procedury / metody.

Dozwolone rodzaje komentarzy:

// komentarz
Dozwolony tylko w przypadku pojedynczej linii, poprzedza wcięcie.
/*
komentarz
*/
Bez ograniczeń.
// TODO
Komentarz informujący o miejscu, które należy wypełnić kodem.

11. Komunikaty

W języku polskim.

Forma komunikatu: bezosobowa

Przykład:
"Proszę podać nazwę kontrahenta!"

Standard kodowania SQL

1. Polecenia SQL

Składnia języka SQL pisana dużymi literami.

2. Nazewnictwo

Język nazw stososowanych w bazie danych: polski.

Nazwy baz danych, tabel oraz kolumn - małe litery, oddzielenie znakiem "_" poszczególnych wyrazów nazwy, długość do 32 znaków.

Standard kodowania CSS

1. Odstępy

Definicje styli powinny być oddzielane 1 linią pustą.

Przykład:
h1 {
}

h2 {
}

Każda para: atrybut: wartość, powinna być oddzielona 1 spacją (odstęp po dwukropku).

Przykład:
h1 {
     color: black;
}

2. Wcięcia

Dla każdej pary atrybut: wartość powinno być stosowane wcięcie równe 1 tabulacji. Przykład jak wyżej.

3. Klamry

Klamry podobnie jak w php znajdują się po jednym odstępie w tej samej linii co nazwa stylu. Przykład jak wyżej.

Standard kodowania JS

1. Ogólne

Jeśli chodzi o wcięcia, komentarze, instrukcje, klamry, operatory to korzystamy ze standardu opisanego dla php.
Różnica występuje jedynie dla nazw zmiennych i funkcji - używamy do tego celu składni znanej z Javy, (nazwy funkcji, zmiennych nie są oddzielane "_", nazwy rozpoczynają sie z małej litery, kolejne wyrazy rozpoczynają się z dużych liter.

Standard kodowania HTML

1. Ogólne

Piszemy zgodnie ze standardem W3C. Wszystkie znaczniki pisane są małymi literami.

Język nazw pól formularzy (parametr name): polski.

Valid HTML 4.01 Transitional