Federico Mena-Quintero
federico@gnome.org 2013
Miguel de Icaza
miguel@gnome.org
Morten Welinder
mortenw@gnome.org
Kvalitní a čitelný kód zajišťuje udržovatelnost projektu

# Význam psaní kvalitního kódu

GNOME je velmi ambiciózní svobodný softwarový projekt a skládá se z velkého množství softwarových balíčků, které jsou na sobě navzájem více či méně závislé. Většina práce na GNOME je prováděna dobrovolníky. Ačkoliv jsou i lidé, kteří na GNOME pracují placeně na plný nebo částečný úvazek, dobrovolníci zatím odvádějí největší díl práce ze všech přispěvatelů. Programátoři mohou přicházet a odcházet kdykoliv a věnovat projektu GNOME libovolné množství času. Lidem se mohou měnit podmínky ve „skutečném světě“ a to se odrazí v množství času, který mohou GNOME věnovat.

Vývoj softwaru zabírá hodně času a vyžaduje nemalé úsilí. To je důvod, proč dobrovolníci na částečný úvazek nemohou začít velké projekty vlastními silami. Je mnohem jednodušší, a přináší uspokojivější výsledky, přispět do stávajícího projektu. Výsledky jsou navíc ihned viditelné a použitelné.

Proto je jasné, že je velmi důležité u stávajících projektů zajistit, aby do nich lidé mohli přispívat jednoduše. Jedním ze způsobu, jak toho dosáhnout, je zajištění snadné čitelnosti, srozumitelnosti, úprav a správy.

Škaredý kód se špatně čte a lidé mohou ztratit zájem, když nemohou rozluštit, o co se kód vlastně snaží. Je také důležité, aby byli programátoři schopni kód pochopit rychle a začít tak přispívat opravami chyb a vylepšeními ve velmi krátkém čase. Zdrojový kód je jistou formou komunikace a slouží spíše pro lidi, než pro počítače. Stejně, jako by se určitě nikomu nechtělo číst román plný překlepů, gramatických chyb a špatné interpunkce, i programátoři by měli usilovat o psaní kvalitního kódu, který je jednoduchý na pochopení a úpravy od ostatních.

Následující věci jsou důležitými měřítky kvality dobrého kódu:

# Čistota

Čistý kód se dobře čte, bez potřeby vynakládat na to nadměrné úsilí. Lidem to pomůže jej snadno pochopit. Patří k tomu přímo styl kódování (umístění závorek, odsazení, názvy proměnných) a vlatní řízení průběhu kódu.

# Jednotnost

Jednotnost kódu usnadňuje lidem porozumět, jak program funguje. Když čtete konzistentní kód, podvědomě si utváříte řadu předpokladů a očekávání o tom, jak kód funguje, takže v něm jednodušeji a bezpečněji můžete provádět změny. Kód, který na dvou místech vypadá stejně, by měl i stejně pracovat.

# Rozšiřitelnost

Kód s obecným účelem se snáze znovu použije a upraví, než velmi specifický kód s řadou natvrdo vložených předpokladů. Když chce někdo do programu přidat novou funkcionalitu, bude to mít samozřejmě jednodušší, když byl kód od začátku navrhován jako rozšiřitelný. Kód, který nebyl psán tímto způsobem, může vést lidi k použití různých nepěkných kliček, aby novou funkcionalitu mohli přidat.

# Správnost

No a konečně, programový kód, který je navržen tak, aby byl správný, nenutí lidi trávit čas trápením s řešením chyb a mohou tak více času věnovat vylepšování funkcionality programu. I uživatelé ocení správný kód, protože nikdo nemá rád software, který se hroutí. Kód, který je napsán správně a bezpečně (tj. kód, který se výslovně snaží zajistit, aby program setrval v konzistentním stavu) zabrání mnoha druhům nepříjemných chyb.

# Doporučené knihy

Code Complete od autora Steve McConnell.

Refactoring: Improving the Design of Existing Code , Martin Fowler.

Design Patterns: Elements of Reusable Object-Oriented Software , kolektiv autorů Erich Gamma, Richard Helm, Ralph Johnson a John Vlissides.

Object-Oriented Design Heuristics , Arthur Riel.