Moja štábna kultúra

Identifikárory

  • anglické názvy

PHP

  • viacslovné identifikátory používajú podčiarovník
    $found_str = "";
 

JavaScript

  • viacslovné identifikátory používajú camel case
  • prvé písmeno je malé
  • prvé písmeno názvu triedy (alebo objektu fungujúceho podobne ako statická trieda) je velké
    foundStr = "";
 

Odsadzovanie

  • o štyri medzery
  • nepoužívajú sa tabelátory
  • jednopríkazový if musí byť na samostanom riadku
    if (true) {
        $value = 42;
    }
 

Blokové zátvorky

  • do bloku sa uzatvárajú aj jednoriadkové podmienené príkazy
    # zakazane:
    if (true)
        $value = 42;
 
    # takto:
    if (true) {
        $value = 42;
    }
 
  • pred otváracou blokovou zátvorkou je vždy jedna(!) medzera
  • otváracia bloková zátvorka sa nachádza na rovnakom riadku ako príkaz if, while, foreach, switch atď
  • uzatváracia zátvorka sa nachádza na samostatnom riadku a na rovnakej úrovni, ako je začiatok riadku, kde je otváracia zátvorka

Príklady

if (true) {
    $value = 42;
}
else if (false) {
    $value = 24;
}
 
while ($found) {
    $found = false;
}
 
foreach ($arr as $value) {
    $sum += $value;
}

Príkaz switch

Príkaz switch sa formátuje nasledovne:

  • zachováva sa odsadenie o štyri medzery
  • príkaz break sa nachádza na rovnakej úrovni ako ostatné príkazy danej vetvy
  • na riadku s návestím (case) sa nesmie nachádzať žiaden príkaz
  • medzi návestiami je jeden prázdny riadok
  • ak viacero návestí zdieľa spoločný kód (prepadávanie), tak medzi nimi nemusí byť prázdny riadok
switch ($val) {
    case 'a':
        do_something();
        break;
 
    case 'b':
        do_something_else();
 
    case 'c':
    case 'd':
    default:
        default_action();
}

Rôzne

  • pred otváracou okrúhlou zátvorkou v podmienených výrazoch sa musí nachádzať medzera
    if (true) ...
    for ($i = 0; $i < 10; $i++) ...
    foreach ($abc) ...
    ...
 
  • nepoužíva sa elseif, ale else if
  • taktiež sa nepoužíva alternatívny dvojbodkový zápis: if:
  • za každou čiarkou nasleduje medzera
  • medzi časťami príkazu for sa nachádza jedna mezera (a to aj v prípade, že niektoré časti sú prázdne)
  • nepoužívajú sa short tags (tj: <? ani <?= )
  • trailing spaces (nadbytočné medzery na konci riadku) sa odstraňujú
  • pokiaľ sa prvky poľa vypisujú po riadkoch, tak za posledným prvkom sa píše čiarka
    $pairs = array(
        'abc' => 'def',
        'ghi' => 'jkl',
    );
 
  • zarovnávanie: kód sa snažíme mať vždy úhľadný
    # taketo nechceme:
    $pairs = array(
       'abc' => 'khasdfjklhskdhfklhsf',
       'defhjshfd' => '487543534543',
       'ghiskdjgfkdl' => 'sdkfjt45y54',
       'vc' => 'jdhfgi',
    );
 
    define('CONST1', 1);
    define('CONST_WITH_LONG_NAME', 2);
 
    # my to napiseme takto:
    $pairs = array(
       'abc'          => 'khasdfjklhskdhfklhsf',
       'defhjshfd'    => '487543534543',
       'ghiskdjgfkdl' => 'sdkfjt45y54',
       'vc'           => 'jdhfgi',
    );
 
    define('CONST1',               1);
    define('CONST_WITH_LONG_NAME', 2);
 
  • medzi operátormi a operandami vo výrazoch by sa vždy mala nachádzať medzera, špecálne pravidlá platia pre priradzovací operátor:
    • obyčajné priradenie ( = ) má pred sebou aj za sebou medzeru
    • priradenie s „doplnkovou“ akciou (+=, -=, *=, .= atď) nemusí mať pred sebou medzeru
        $query = "select abc from table ";
        $query.= "where def='2'";
 
  • identifikátory parametrov metód a funkcií (a rovnako premenné, do ktorých sa kopírujú post, get, cookie a session premenné) musia začínať podtržítkom, aby bolo možné na prvý pohľad odlíšiť parametre od bežných premenných
rozne/moja_stabna_kultura.txt · Posledná úprava: 10.03.2010 10:44 od perun
Hore
chimeric.de = chi`s home Creative Commons License Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0