Coding Standards

Coding standards

• soubory se zdrojovým kódem jsou ve formátu UTF-8
• dokumentace v rámci zdrojových souborů je anglicky (s použitím dokumentačních komentářů)
• komentáře v rámci zdrojových souborů jsou anglicky
• kód v Javě by se měl řídit standardními konvencemi - pdf, html
  • speciálně jako jednotka odsazování se používají čtyři mezery
  • pro automatické formátování kódu v Eclipse není potřeba žádný plug-in, nastavuje a provádí se přes:
    • Window->Preferences->Java->Code Style->Formatter/Clean Up
    • Source->Format (Ctrl+Shift+F), Source->Clean Up - ruční formátování/čištění
    • Window->Preferences->Java->Editor->Save Actions - automaticky při ukládání

Logování

Pro logování činnosti software bude použit framework Log4J.

Úrovně zpráv budou používány takto:

• FATAL - nezotavitelná chyba programu,
• ERROR - zotavitelná chyba programu,
• WARN - warning, podezřelá situace, která může a nemusí být chybou,
• INFO - základní popis průběhu aplikace,
• DEBUG - výpisy důležitých proměnných, podrobnější zprávy o průběhu aplikace.

---

Zpět na implementaci.