Štábní kultura: Porovnání verzí
Z Freenetis Wiki
Řádek 16: | Řádek 16: | ||
*/ | */ | ||
− | === | + | === Odsazování === |
+ | Odsazování zdrojového textu se provádí pomocí tabulátoru. | ||
+ | === Zalamování === | ||
− | == | + | |
+ | Řádek kódy controllerů, modelů a helperů by neměl přesahovat 80 znaků. | ||
+ | Pro řádky přesahující tuto délku zalamujeme zdrojový kód dle následujících pravidel: | ||
+ | |||
+ | '''Zalamování polí''' | ||
+ | |||
+ | array | ||
+ | ( | ||
+ | 'a', 'b', c', 'd', 'e', | ||
+ | 'f', 'g' | ||
+ | ); | ||
+ | |||
+ | array | ||
+ | ( | ||
+ | 'a' => val1, | ||
+ | 'b' => val2 | ||
+ | ); | ||
+ | |||
+ | '''Zalamování argumentů funkcí''' | ||
+ | |||
+ | ''Odsazení vnitřních argumentů: 2 tabulátory'' | ||
+ | |||
+ | funkce(arg1, arg2, | ||
+ | arg3, arg4 | ||
+ | ); | ||
+ | |||
+ | nebo | ||
+ | |||
+ | funkce( | ||
+ | arg1, arg2, | ||
+ | arg3, arg4 | ||
+ | ); | ||
+ | |||
+ | '''Řetězené metody objektů''' | ||
+ | |||
+ | Toto zalamování je vhodné i pokud řádek kódu nepřesahuje 80 znaků. | ||
+ | ''Odsazení: 2 tabulátory'' | ||
+ | |||
+ | $object->method1() | ||
+ | ->method2(); |
Verze z 7. 7. 2011, 12:57
Vývojářům FreeNetISu je doporučeno dodržovat zde definované pravidla pro zvýšení čitelnosti a jednotnosti zdrojových kódů.
Každý zdrojový soubor by měl začínat následujícím kódem:
<?php defined('SYSPATH') or die('No direct script access.'); /* * This file is part of open source system FreeNetIS * and it is released under GPLv3 licence. * * More info about licence can be found: * http://www.gnu.org/licenses/gpl-3.0.html * * More info about project can be found: * http://www.freenetis.org/ * */
Odsazování
Odsazování zdrojového textu se provádí pomocí tabulátoru.
Zalamování
Řádek kódy controllerů, modelů a helperů by neměl přesahovat 80 znaků. Pro řádky přesahující tuto délku zalamujeme zdrojový kód dle následujících pravidel:
Zalamování polí
array ( 'a', 'b', c', 'd', 'e', 'f', 'g' );
array ( 'a' => val1, 'b' => val2 );
Zalamování argumentů funkcí
Odsazení vnitřních argumentů: 2 tabulátory
funkce(arg1, arg2, arg3, arg4 );
nebo
funkce( arg1, arg2, arg3, arg4 );
Řetězené metody objektů
Toto zalamování je vhodné i pokud řádek kódu nepřesahuje 80 znaků. Odsazení: 2 tabulátory
$object->method1() ->method2();