Commentare non è mai inutile

Post del 1 Marzo 2021 in Developer

Quando si lavora in team, capita piuttosto spesso che, a causa di progetti paralleli o della scarsità di tempo, si debba mettere mano sul lavoro di qualcun altro.

Ovviamente, vige sempre la regola che, ognuno, scrive il codice in modo soggettivo in base alla propria esperienza e alle proprie competenze, pur rispettando la best practice e le convenzioni che si sono stipulate all’inizio di un determinato progetto.

E se la fretta è troppa?

Purtroppo, anche in questo caso, commentare diventa fondamentale. Capita piuttosto raramente che una volta preso in mano un progetto, sviluppato e completato, non ci si debba più mettere mano.

Commentare il proprio codice, non serve solamente ad aiutare gli altri a capire quello che intendevate fare nelle successive righe di codice, ma aiuta anche noi stessi, nel caso in cui in futuro dovessimo effettuare delle modifiche o degli aggiornamenti.

Prevenire è meglio che curare

Mi capita spesso di pensare: “vabbè, intanto lo scrivo, poi dopo lo rileggo e commento”. Penso che qualsiasi programmatore una volta nella vita abbia fatto un pensiero come questo.

Quando si devono creare porzioni di codice che utilizziamo più spesso, il problema non si pone. Dopotutto, siamo piuttosto bravi a percorrere la stessa strada. Ma quando dobbiamo creare qualcosa di completamente nuovo?

In tal caso, quello che veramente aiuta, prima di buttarsi a capofitto nello scrivere il codice è individuare i punti chiave dello sviluppo, ed elencarli tramite vari commenti. A questo punto, non dovremo fare altro che sviluppare ogni singolo punto (già commentato) fino ad arrivare alla fine dell’intero codice.

Troppi dettagli non aiutano mai

Quando si commenta, oltretutto, non bisogna mai essere troppo prolissi. Dopotutto si tratta di un testo che l’utente non leggerà mai, e proprio per questo deve essere sintetico e simbolico. È un chiaro aiuto, prima di tutto per noi stessi e poi per eventuali altri sviluppatori che dovranno modificarlo.

Cerchiamo sempre di tenere pulito ed ordinato il nostro codice, qualsiasi linguaggio di programmazione stiamo utilizzando.

Un buon codice, è un codice che è semplice e veloce da implementare.

Lascia un commento

Il tuo indirizzo email non sarà pubblicato. I campi obbligatori sono contrassegnati *

L'Alchimista tecnologico

Mi chiamo Cristian, sono l’autore di questo blog e realizzo software e siti web da più di 10 anni.

Creazione sito web

Hai bisogno di un sito web? Dai un'occhiata alle soluzioni che abbiamo sviluppate sino ad ora.

Creazione software

Le soluzioni che abbiamo sviluppato rispettano sempre standard di qualità e prestazioni elevati.