Clean code - Non solo le donne fanno le pulizie

Fermi tutti, per favore abbassate quelle torce e i forconi... il titolo è clickbait e provocatorio, è stato pensato solo ed esclusivamente per attirare views, siamo tutti amici qui. Bene, ora che ci siamo calmati, passiamo all'articolo di oggi.

Tutti noi developers scriviamo codice ma quanti di noi possono dire di scrivere davvero del codice pulito?

A questa domanda la mia personale risposta è: "si credo di scrivere del codice pulito e leggibile" ma visto che nel nostro lavoro non si finisce mai di imparare, ho deciso di approfondire questa cosa e ho comprato un libro che parla di clean code. Tra i tanti libri consigliati in rete ho deciso di prendere questo: 

Che cos'è il clean code?

Dopo aver letto il libro proverò a riassumere il tutto nel modo più breve e chiaro possibile. Il clean code è un insieme di buone pratiche che mirano a scrivere codice leggibile, mantenibile e facile da comprendere. Esistono diverse tecniche per scrivere clean code, ma alcuni dei principi chiave sono:
  • Usa nomi descrittivi per le variabili, le funzioni e gli altri elementi del tuo codice.
Esempio di cattivo nome:

int d; // elapsed time in days

Esempio di buon nome:
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;
  • Usa commenti solo quando sono davvero necessari. In genere, è meglio che il codice parli da solo.
Meglio questo codice:

// Check to see if the employee is eligible for full benefits
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))O questo?
if (employee.isEligibleForFullBenefits())
    • Mantieni la coerenza nello stile di codifica. Adotta uno stile di codifica e segui sempre le stesse regole.
    • Scrivi codice modulare, ovvero suddividilo in funzioni piccole e facili da comprendere.
    • Usa il principio di minimo sforzo quando scrivi codice. Cerca di evitare di scrivere codice aggiuntivo se non è strettamente necessario.
    • Testa il tuo codice accuratamente per garantirne la correttezza.
    • Mantieni il tuo codice aggiornato e rimuovi eventuali parti non utilizzate o obsolete.
    • Le classi e i metodi ridotti e possibilmente che hanno un solo compito ben preciso.

      Vi lascio uno snippet di codice, decidete voi quale tra i due è più leggibile e chiaro


    Conclusione

    In sintesi, il clean code consiste nello scrivere codice che sia facile da leggere, comprendere e mantenere nel tempo. In questo modo, sarai in grado di lavorare in modo più efficiente e il tuo codice sarà più robusto e meno suscettibile agli errori. Spero che questo articolo ti sia utile per scrivere codice pulito e utilizzare quei patterns che semplificano il tuo codice dandogli qualità.

    Commenti

    Posta un commento

    Post popolari in questo blog

    Inbox & Outbox pattern - La consegna dei messaggi ai tempi moderni

    Immagine
    Uno degli aspetti fondamentali dell'architettura dei microservizi è la gestione dei dati. Può capitare che un microservizio debba scambiarsi informazioni con un altro  microservizio, questo scambio di informazioni può avvenire tramite API o tramite un broker di messaggi. Di solito, quando lo scambio di informazioni avviene tramite messaggi, è essenziale assicurarsi che il messaggio inviato raggiunga la sua destinazione e perderlo potrebbe comportare dei rischi aziendali. Consideriamo un semplice scenario di esempio. Il microservizio A ha appena terminato di elaborare alcuni dati e li ha salvati sul database, ora deve notificare al microservizio B che ha terminato il suo compito e che sono disponibili nuove informazioni da recuperare. La soluzione più semplice sarebbe semplicemente inviare una richiesta REST al microservizio B dopo aver salvato i dati sul database giusto? SBAGLIATO . Questa casistica di esempio può presentare alcuni inconvenienti, il più importante è uno...
    Continua a leggere »

    I Behavior-Driven Development (BDD): La Magia dei Test che Parlano

    Immagine
    I l Behavior-Driven Dev elopmen t (BDD) è una metodologia di sviluppo software che prende le basi del Test-Driven Development (TDD) e le arricchisce, focalizzandosi sul comportamento del sistema dal punto di vista dell'utente finale. Dopo aver sperimentato il TDD in diversi progetti, ho scoperto che il BDD offre un ulteriore livello di chiarezza e collaborazione, facilitando la comunicazione tra sviluppatori, tester e stakeholder non tecnici. Il BDD utilizza un linguaggio naturale per descrivere le funzionalità del sistema, rendendo i requisiti accessibili e comprensibili a tutti i membri del team. Il Processo del BDD Il BDD si basa su scenari che descrivono il comportamento desiderato del sistema. Questi scenari sono scritti in un linguaggio formale ma leggibile, spesso Gherkin, che segue una struttura standard "Given-When-Then": Scrivi uno Scenario (Given-When-Then): Given: Definisce il contesto iniziale o le precondizioni. When: Descrive l'azione o l'evento c...
    Continua a leggere »

    #4 Space Invaders - Vola navicella....Vola - Unity Tutorial

    Immagine
    Nel precedente articolo abbiamo creato un esercito di invasori. Ora è il momento di concentrarci sul nostro eroe: il player! Ma non parliamo di un semplice "giocatore". No no no, parliamo di una navicella spaziale in grado di volare tra le stelle e sparare laser senza sosta! Se siete pronti, allacciate le cinture e preparatevi a far volare questa navicella! Proiettili laser Prima di far volare la nostra navicella, creiamo la sua arma: i proiettili laser. Dalla cartella Sprites, trasciniamo  lo sprite chiamato  Laser  nella nostra Hierarchy . Coloriamolo con lo stesso colore del player, in modo che l'utente sappia che si tratta del laser del player, Aggiungiamo un Box Collider 2D e spuntiamo la casella  is Trigger. Successivamente, rendiamo il proiettile un componente fisico, aggiungendo un RigidBody 2D per  simulare la fisica dell'oggetto, inclusi le collisioni. Impostiamo il  Body Type  de l RigidBody 2D su  Kinematic.  Come abbiamo fatto in...
    Continua a leggere »