Nomi significativi, funzioni brevi, niente commenti inutili. I principi del Clean Code applicati al lavoro quotidiano di un team di sviluppo.
Robert Martin (Uncle Bob) nel suo libro Clean Code ha codificato principi che ogni sviluppatore dovrebbe conoscere. Il codice viene letto molto piu spesso di quanto viene scritto: scrivere codice leggibile e un atto di rispetto verso chi verra dopo, spesso te stesso tra sei mesi.
Nomi significativi
I nomi di variabili, funzioni e classi devono rivelare l'intenzione. daysSinceLastLogin dice tutto, d non dice nulla. getCustomerShippingAddress e auto-documentante, getInfo non lo e. Se fai fatica a trovare un nome, probabilmente la funzione fa troppe cose.
Funzioni piccole che fanno una cosa sola
Il principio Single Responsibility applicato alle funzioni: ogni funzione deve fare esattamente una cosa e farlo bene. Una funzione di 200 righe che fa parsing, validazione, trasformazione e persistenza e impossibile da testare, debuggare e riusare.
Commenti utili (e quelli da eliminare)
I peggiori commenti spiegano cosa fa il codice: il codice deve spiegarlo da solo. I commenti utili spiegano il perche di una scelta non ovvia. Mai lasciare codice commentato nel repository: usa il version control per questo.
Il boy scout rule
Lascia il codice un po' meglio di come l'hai trovato. Rinomina una variabile oscura, spezza una funzione troppo lunga, rimuovi un commento obsoleto. Nel tempo il codice migliora organicamente invece di degradare.
Hai bisogno di supporto su questo tema?
Il team di SoDaTech e a disposizione per una consulenza gratuita e senza impegno.
Contattaci