styleguide

Podstawy

• kod wcinamy tabami
• kodowanie - UTF-8
• nazwy w kodzie po angielsku
• komentarze po polsku (komentujemy tylko te wycinki kodu, które mogą być niezrozumiałe dla innych); można pisać ewentualnie też po angielsku, to co po polsku brzmi beznadziejnie
• niezrozumiałym nazwom zmiennym mówimy NIE
• niezastosowanie się do powyższych zaleceń oznacza *****
• używamy pojedyńczych cudzysłowów do stringów (z wyłączeniem przypadków kiedy chcemy użyć np. "\n", bądź automatycznej interpolacji

Ogólne

• klasy: SomeClass
• zmienne publiczne:
  • JavaScript: some_value
  • PHP: $someValue
• zmienne chronione (i prywatne):
  • JavaScript: _some_value
  • PHP: $_someValue
• metody: someMethod

JavaScript

• zawsze średniki na końcach instrukcji
• w pozostałych wypadkach, nie opisanych wyżej styl Crockforda (i zgodność z jslintem ;>)

Np.:

var fn = function (list) {
	var x = 0;
	for (var i = 0, l = list.length; i < l; ++i) {
		console.log(i);
	}
	return x;
};

PHP

• pliki ze skryptami PHP rozpoczynamy (od pierwszej linii!) tagiem <?php i nie kończymy pliku tagiem zamykającym - to poprawne i zapewni, że żadne brzydkie białe znaczki nie wylecą na stdio
• echowanie w templateach robimy za pomocą krótkiego tagu <span><?= $x ?></span>
• komentarze jednoliniowe // xxx, wielo (dla klas):

/**
 * PHP
 * jest do bani
 */

bądź (np. zakomentowywanie kodu):

/*
$this->isNotNeeded(
    'here'
);
*/