Standardy tvorby zdrojového kódu

Systém Drupal se pyšní perfektní sadou programovacích standardů, jejichž dodržování si důrazně vynucuje. Veškerý zdrojový kód jádra se řídí těmito standardy; stejně tak většina modulů doplňků. Než se pustíte do programování, měli byste se seznámit s těmito standardy, a to kupříkladu zde: http://drupal.org/coding-standards. Modul Coder umí analyzovat váš zdrojový kód a upozorní vás na jakýkoliv přestupek vůči programovacím standardům.

Programovací standardy nebudeme procházet všechny, protože podrobné informace jsou k dispozici na Googlu, ale několik standardů si řekneme:

  • Odsazování: ve všech souborech jazyků PHP a JavaScript používáme dvě mezery k odsazení. K formátování zdrojového kódu nikdy nepoužíváme tabulátory.
  • Značky <?php a ?>: soubory obsahující čistě jen kód jazyka PHP by měly začínat značkou <?php, ale na jejich konci bychom měli vynechat značku ?>. To děláme z mnoha důvodů, ale především proto, abychom zabránili bílým znakům v rozbití hlaviček protokolu HTTP.
  • Komentáře: v Drupalu používáme dokumentační bloky ve formátu pro dokumentační nástroj Doxygen(/** */) ke komentování funkcí, tříd, rozhraní, konstant, souborů a globálních proměnných. U všech ostatních komentářů bychom měli používat dvě lomítka (//). Znak dvojitého křížku (#) bychom neměli používat pro komentáře vůbec.
  • Mezery okolo operátorů: na každoustranu od většiny operátorů bychom měli vkládat bílý znak.
  • Mezery u řídicích struktur: řídicí struktury by měly mít mezeru za klíčovým slovem a před složenou závorkou. Tělo každé řídicí struktury bychom měli uzavřít mezi složené závorky, a to
    dokonce i u příkazu if s jednořádkovým tělem.
  • Funkce: jména funkcí bychom měli psát malými písmeny a slova oddělovat podtržítky. Později zjistíme, jak se liší jména metod tříd.
  • Proměnné: jména proměnných by měla mít malá písmena a podtržítka mezi slovy. Členské proměnné (vlastnosti) objektů se řídí jinými pravidly.

Sdílejte, pokud vám to k něčemu bylo :)