Správný programátorský styl

Zásady čitelného kódu

Mezi zásady správného psaní kódu mimo jiné patří:

• jeden příkaz na jeden řádek,
• pozitivní zápis podmínek,
• nepoužívání příkazů skoku,
• používání výstižných názvů proměnných,
• správné odsazování,
• užívání jednotného stylu zápisu identifikátorů.

Odsazování

Pro odsazování doporučuji používat jeden ze stylů:

• K&R (C) – dnes asi nejpoužívanější,
• Allman (ANSI C, vhodný i pro Pascal – stačí závorky nahradit

  begin

  a

  end

  ).

Konvence pro zápisy identifikátorů v Javě¹

Třídy a rozhraní

Identifikátor začíná vždy velkým písmenem, ostatní písmena jsou malá. Každé další slovo začíná velkým písmenem.

• StringBuffer

Metody a proměnné

Identifikátor začíná vždy malým písmenem, ostatní písmena jsou malá. Každé další slovo začíná velkým písmenem.

• pocetPrvku

• getSize()

Balíky

Identifikátor se skládá pouze z malých písmen.

• java.lang

Konstanty

Používají se pouze velká písmena, slova se oddělují podtržítkem.

• MIN_VALUE

Automatické naformátování kódu K&R

Ke správnému formátování kódu PHP, Javy, C/C++ můžete použít např. editor NetBeans, který má v menu příkaz Source → Format. Automaticky pak zformátuje kód podle určitých předem daných pravidel – používá styl K&R. Mně vyhovuje nyní nejvíce Visual Studio Code, který formátuje kód automaticky při uložení souboru.

Více informací

• Styl zápisu programu – wikipedia.org,
• Indent style – wikipedia.org,
• Standard pro zápis C++ – Jan Ringoš,
• Základy programování Zdrojový kód, dokumentace, týmová práce – Petr Šaloun.