2. Szeretem a szellős kódot.
Plusz továbbiak, amik szerintem ennél fontosabbak:
- Legyen szellős, jól olvasható a kód.
- Egy metódus/függvény lehetőleg ne legyen nagyobb, mint amennyi egy képernyőre kifér. (kb. 40-50 sor)
- Metódusok után minimum 2 sor legyen.
- Egy osztály lehetőleg egy fájl legyen.
- Minden dologról derüljön ki az, hogy mire való. Inkább legyen hosszabb neve, de egyértelmű és ne valami agyonrövidített cucc.
- Lehetőleg 80 karakternél ne legyen szélesebb egy sor, hogy jól olvasható legyen.
- SQL query szétbontva, indentálva, pl.
$db->query('SELECT tamtaramtatam
FROM akarhonnan
LEFT JOIN megvalami USING (bigyula)
WHERE ez AND az
ORDER BY ingyombingyom
LIMIT 10 OFFSET 0');
- Legyen kommentelve, ha valaki bugfixet csinál ott a helyén
- Mindig legyen zárójelezés. Sokkal egyértelműbb és hibamentesebb, ha mondjuk egy ilyet kell nézni ((a * b) + (c * d)), ahol egyből látszik az összetartozó tag.
- Legyen egységes a metóduselnevezés (meglepő, de csúnyán tudja lassítani az embert)
- Hungarian notation, bár ez még nem megy mindenhol tökéletesen... Nem olyan hülyeség az, főleg ha valami nem túl típusos nyelvben kell kódolni.
- Legyenek értelmes, debuggolható hibaüzenetek, logok, stb.
- Legyen SVN commit log és derüljön ki belőle, hogy mi a halált csinált. (hihetetlen, de egyeseknek ezt is magyarázni kell. Volt egy külsős arc, aki egy ideig nem írt, rászóltunk, aztán sokadjára elkezdett írni... Beírta mindig a nevét.
- Lehetőleg kisebb SVN commitok legyenek, amik egy részfeladathoz tartoznak, ne nap végén a n+sok megoldást egyszerre.
- Ha valami nyelvnek van értelmes és jól kidolgozott konvenciója (pl. C#), akkor azt kell használni.
----------------
Lvl86 Troll