Bones pràctiques per escriure codi

Estàs escrivint codi per llegir-lo en el futur, o bé per un altre...

1. Les classes han de ser petites, per sota de 500 línies, i han de tenir un nombre limitat de mètodes
2. Els mètodes han de ser petits, per sota de 30 línies, i han de fer una feina concreta
3. Has d’escriure el codi perquè s’expliqui a ell mateix, però on no arribis, utilitza comentaris
4. No facis línies massa llargues, com a molt de 120 caràcters
5. Indenta el codi per cada nivell d’anidament, i intenta no superar els 3-4 nivells
6. Si hi ha dades d’entrada, crea-les des del codi per no haver d’introduir-les des del teclat
7. Anomena les classes, els mètodes i les variables amb els criteris ja explicats
8. Decideix el teu estil i segueix-lo de forma consistent

És dolent el teu codi?

1. És massa rígid? Es poden canviar els detalls interns d'aquest mòdul en el futur sense tocar el codi d'altres mòduls i altres capes? El codi rígid és el que té dependències que serpentegen en tantes direccions que no es pot fer un canvi aïllat sense canviar-ho tot al voltant.
2. És massa fràgil? Seria difícil trobar llocs on fer canvis i refactoritzar en el futur? El codi fràgil es trenca de formes estranyes i que no es poden predir.
3. Hauria de ser una característica reutilitzable? Si ho fos, el codi depèn de mòduls no desitjats que es podrien evitar? Vols una banana, però el que obtens és un goril·la agafant-la i tota la jungla amb ell.

Si mirem de prop, el fil conductor dels tres problemes esmentats és l'acoblament. Els mòduls depenen els uns dels altres de maneres no desitjades i resulten en un codi espagueti.

El codi hauria d'estar desacoblat entre els mòduls i les capes. Les polítiques d'alt nivell i les abstraccions no haurien de dependre de detalls de baix nivell, sinó d'abstraccions: caldria invertir la dependència dels mòduls als llocs necessaris. I escriure classes que només fan una cosa i només tenen un motiu per canviar.

El codi bo hauria d'explicar què està fent. Hauria de ser avorrit de llegir. Tot hauria de ser perfectament obvi. Això és bon codi - Robert Martin.