Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 2.81 KB

code-style.md

File metadata and controls

52 lines (38 loc) · 2.81 KB

Code style PHP

  • 2 znaky mezera – odsazení
  • Mezery kolem = . + a dalších podobných operátorů
  • Bez mezer za klíčovými slovy if(podmínka) { ... }
  • Otvírací složená závorka vždy na stejném řádku function mojeMetoda($argument) { ... }
  • LF – znak konce řádku, CR nepoužívat
  • Uzavírací závorka před else } else {
  • Zbytek standardy – pro zbytek, není-li řečeno jinak, je nutné dodržovat standardy, tj. PSR-1 a PSR-2

Další doporučení:

  • 80 znaků na řádek
  • Respektovat existující kód – pokud už nějaký kód je kolem (a není starý nerespektující aktuální style guide), tak se snažíme okopírovat jeho styl i v kódu co přidáváme.
  • Neměnit nesouvisející věci – code style opravujeme jenom na místech, která měníme v rámci programování daného commitu. Pokud ho chceme změnit i jinde v souboru, musíme tyto změny přidat v samostatném commitu.
  • Zarovnávat – u věcí pod sebou jako jsou => v polích nebo více přiřazení = je často hezčí zarovnat. Řídíme se úsudkem a respektováním okolního kódu.
  • Jednoduché podmínky oneline – následující je v pohodě:
if($podminka) udelejNeco();
else          throw new Exception('nesplněno');

Code style JS

JavaScript Standard.

Code style SQL

SELECT u.email1_uzivatele as 'mail'
FROM uzivatele_hodnoty u
JOIN uzivatele_role uz ON
  uz.id_uzivatele = u.id_uzivatele AND -- [1]
  uz.id_role = {zPritomen}
LEFT JOIN medailonky m ON m.id_uzivatele = u.id_uzivatele
WHERE u.souhlas_maily AND NOT u.mrtvy_mail
ORDER BY u.email1_uzivatele
  • Jen JOIN a LEFT JOIN – další varianty (INNER, OUTER, NATURAL, ...) nepoužívat.
  • Dlouhé podmínky na více řádků – viz [1], odsazení 2 mezery, spojka mezi řádky se píše na konec řádku, spojka mezi všemi řádky musí být stejná (AND nebo OR), pokud jsou spojky i uvni řádku, je vhodné ho uzávorkovat.
  • Dlouhé SELECTy na více řádků – odsadit a hodnota per řádek podobně jako u podmínek.

Nastavení editorů

Je vhodné nastavit si editor, aby code style (minimálně u PHP a JS) kontroloval. Určitě to umí minimálně Sublime, Atom, Netbeans, PhpStorm.

Pokud váš editor generuje nějaké pomocné složky / soubory, nastavte si globální .gitignore a přidejte je do něj.

NetBeans: code style, který si můžete importovat, je na google drive ve složce "I: Web a IT" archiv "konfigurace NetBeans.zip" s nastavením pro import. Pro zformátování kódu podle style guide v NetBeans označte Vámi upravenou část kódu a použijte klávesovou zkratku Alt+Shift+F. Nepoužívat pro celý skript.