Hogyan írjak szép olvasható kódokat?

Legegyszerűbb, ha betartod az adott nyelvre, platformra vonatkozó (elnevezési, kódformázási) konvenciókat. Ezek is mindig kiemelik, de fontos, hogy beszédes, érthető változóneveket adj meg (illetve mindenhol fontos, de csak változónál találkoztam eddig 'a', 'aa', 'aaa' meg hasonlóan elmés elnevezésekkel), és lehetőleg angolul dolgozz.

Az meg, hogy az elsőre elkészült kódrészlet nem lesz átlátható, mindenkivel előfordul, ekkor jön a refaktorálás, azaz a kód felépítésének átalakítása úgy, hogy a funkcionalitása ne változzon.

Egyébként elismerésem, hogy ilyen kérdés foglalkoztat, egynéhány magát programozónak tekintő sem ennyire igényes, hogy ezzel törődne.

#2 és #3 mellé kiegészítésként:

Kommenteket is írhatsz a kódba. Egy egy elkülöníthető utasítássorozat vagy nem annyira egyértelmű utasítás elé leírhatnád röviden (1 sorban), hogy mit csinál.

Illetve érdemes alkalmazni doclet-eket, pl. Java esetén Javadoc-ot.

Néhány szabály, amelyeket nyelvfüggetlenül ajánlanak:

Használj beszélő neveket.

Ne fukarkodj a kommentekkel.

Használj behúzásokat a blokkok belsejében.

Az include, import, require, ... után hagyj egy üres sort; ugyanígy a függvények, metódusok, osztályok között.

Nyelvfüggő ajánlások:

Tartsd be a nyelv konvencióit.