Perché la qualità del codice è un grosso problema per gli sviluppatori?

La qualità del codice può tradursi in quanto è utile e manutenibile il tuo codice: il codice di alta qualità può essere riutilizzato e ri-sviluppato; il codice di bassa qualità non dura.

I progetti sono spesso una corsa contro il tempo e il budget così stretto che contare su un paio di mani in più per scrivere codice è una chimera. Tagliare gli angoli può sembrare la via più semplice, ma non pagherà nel lungo periodo.

Il codice ben strutturato, seguendo le regole della lingua, è molto più facile da leggere e capire da diversi browser e altri sviluppatori. È anche più affidabile ed evita future rielaborazioni.

I progetti software possono essere soggetti a diversi vincoli in diverse fasi (dai requisiti all’analisi, sviluppo, test, implementazione e manutenzione) che a volte possono portare al codice stesso gestito come l’aspetto meno importante (funzione rispetto alla forma). Tuttavia, una delle proprietà più importanti-e spesso dimenticate-di un buon software è la qualità del codice.

La qualità del codice può essere misurata in diversi modi, ma alcuni degli aspetti più importanti sono:

• Leggibilità, coerenza: quanto è facile leggere e comprendere sezioni del codice; ciò include chiarezza, semplicità e documentazione del codice.
• Prevedibilità, affidabilità e robustezza: il comportamento del software deve essere prevedibile e non soggetto a bug nascosti.
• Manutenibilità ed estensibilità — fissare, aggiornare e migliorare il software dovrebbe essere il più semplice possibile, non intrinsecamente complesso.

Perché la qualità del codice è davvero importante?

Dati i soliti vincoli già presenti nello sviluppo del software, perché lo sforzo di produrre codice di qualità dovrebbe essere così importante?

Scrivere codice di qualità non deve essere considerato come un dispendio di tempo, ma piuttosto come uno degli obiettivi principali durante lo sviluppo di software; esso deve essere considerato come un investimento essenziale su cui tornare a seguire quasi subito:

• il Codice che è altamente leggibile, coerente e documentata è più facile rivedere, portando ad una molto più basso sforzo di sviluppo.
• Il codice pulito ed elegante è anche molto più facile da capire, mantenere ed estendere.
• Il software che è ben progettato e raggiunge una complessità di codice inferiore beneficia anche molto in termini di testabilità e robustezza (meno inclini a nuovi bug introdotti).

In sostanza, un’elevata qualità del codice è uno dei modi più efficaci per ridurre il debito tecnico.

Lascia che ti mostri un esempio

Il codice di scarsa qualità può essere solitamente causato da:

• Mancanza di (o insufficiente) stile/standard di codifica.
• Nessuna / scarsa documentazione.
• Architettura mal progettata (senza separazione delle responsabilità, come in MVC).
• metodo ad Alta complessità

Nell’esempio seguente, l’obiettivo del metodo non può essere chiaramente identificato, senza un attento esame:

• non Vi è alcuna funzione di documentazione, n righe di commento, e nessun apparente standard di codifica è seguito (vedere, per esempio, l’uso di parentesi graffe e le righe vuote).
• La complessità è relativamente elevata a causa del numero di azioni e processi diversi (query DB, visualizzazione/output e logica di business), più livelli di nidificazione.
• C’è un’incoerenza nei modi per eseguire l’output e l’interpolazione variabile.

Data la sua bassa qualità, il codice è soggetto a errori/bug (per non parlare di problemi di sicurezza) e difficile da testare correttamente.

Inoltre, qualsiasi modifica al software probabilmente comporterà un aumento dello sviluppo e dei test e comporterà comunque l’introduzione di potenziali nuovi bug.

Sul lato opposto, seguire uno standard di codifica e documentare il codice è un aspetto chiave della qualità.

Un esempio casuale di questo può essere visto nell’immagine seguente, una sezione del Controller FrameworkBundle di Symfony.php:

Oltre alla documentazione del metodo / parametro, possiamo vedere chiaramente che:

• Il codice è semplice e auto-esplicativo.
• Diverse sezioni logiche sono separate da linee vuote.
• Ci sono pochi livelli di nidificazione/rientro, con dichiarazioni di ritorno anticipato.
• Esistono considerazioni di progettazione appropriate (separazione delle responsabilità da diversi oggetti/classi).
• A causa dell’elevata qualità e chiarezza del codice, la classe/metodo dovrebbe essere facile da testare e mantenere, con un basso sforzo; anche la probabilità che si verifichino bug dovrebbe essere estremamente bassa.

Come si può ottenere un’elevata qualità del codice?

Ecco alcuni suggerimenti:

• Scelta di uno standard di codifica (stile) appropriato per la lingua o il framework. Per PHP, ad esempio, PSR-2 può essere considerato come la raccomandazione standard corrente. Potrebbe essere possibile integrare gli strumenti CS fixer con il proprio ambiente di sviluppo (vedere php-cs-fixer)
• La coerenza nei nomi di classi, metodi e variabili è un altro importante fattore di leggibilità.
• Assicurandosi di documentare correttamente classi, proprietà, metodi e particolari blocchi di codice quando necessario, assicurando che i commenti siano semplici, concisi ed efficaci.
• Il refactoring e la scelta di modelli di progettazione corretti sono un buon modo per promuovere la riusabilità e l’estensibilità del codice e per ottenere una complessità di classe/metodo inferiore.
• Aggiunta di strumenti di analisi del codice all’ambiente CI, da eseguire prima di unire nuove modifiche. Per PHP, phpmd e / o phpstan sono strumenti che possono avvertire di potenziali problemi nel codice e hanno un numero di diverse regole configurabili.
• Il test automatico è un altro must-have; non solo aiuterà a prevenire nuovi bug, ma anche a garantire che soddisfi i requisiti e risponda correttamente a diversi input.
• Infine, sfruttando strumenti come scrutinizer-ci e Codacy per testare e visualizzare una chiara panoramica della qualità di un progetto nel tempo, e dettagli importanti su cosa e dove sono i problemi.

Bottom line

Indipendentemente dalle metodologie di sviluppo, dai linguaggi, dai framework o dagli strumenti, far rispettare un’elevata qualità del codice è un modo per ottenere sviluppo, test e manutenzione più rapidi e semplici, che si traduce in costi ridotti di proprietà del software.

Scritto da João Inácio | Senior Developer e Team Leader di Cleverti

Questo articolo è stato originariamente pubblicato sul blog di Cleverti