Skip to content

styleguide

Reinmar edited this page Oct 4, 2011 · 13 revisions

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)
  • 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: some_value
  • zmienne chronione (i prywatne): _some_value
  • 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:

/**

  • PHP
  • jest do bani */
Clone this wiki locally