Vale per tutti i linguaggi di programmazione: un codice pulito è più bello e più facile da mantenere. Mettere mano a un codice non curato, senza commenti, ecc... è senz'altro una scocciatura e fa perdere un sacco di tempo.

Ecco 5 consigli utili a chi si sta avvicinando al mondo della programmazione, sperando che i programmatori più "sgamati" già li seguano.

1. L'indentazione
Indentare il codice è molto importante: ad una prima occhiata il codice identato correttamente salta subito all'occhio per l'ordine e la facile lettura.

La tecnica è basata sull'idea di usare gli spazi bianchi (in genere ignorati da compilatori e interpreti) allo scopo di separare più chiaramente le istruzioni e, in particolare, di rappresentare esplicitamente le relazioni di annidamento.

In genere, l'indentazione segue la cosiddetta off-side rule, che consiste nell'anteporre a ogni istruzione una quantità di spazio bianco (spazi, tabulatori) proporzionale al numero di strutture di controllo o blocchi a cui tale istruzione appartiene.

2. I commenti
Bisogna prendere il "vizio di commentare". E' una scocciatura, lo so, ma aiuta anche chi scrive il codice a tenere traccia di quanto sta facendo. Alla fine non costa molto, e diventerà un'abitudine come lo è diventata per me. Chi leggerà il vostro codice vi ringrazierà.

Un commento ogni riga è certamente troppo, ma ad ogni ciclo, funzione o "blocco logico" di istruzioni una riga di commento è quantomeno necessaria. Lasciate perdere i commenti su più righe, una riga nel 99% dei casi è più che sufficiente. Quindi, una riga, stringata ma chiarificatrice basta e avanza.

// Stampa dati ritornati da query

E' un commento breve e sicuramente esplicativo inserito nel contesto giusto.

3. Le variabili
Più che le variabili si tratta dei nomi dati alle variabili... var1, var2, ecc... Non spiegano certo cosa contengono o a cosa servano. Nei linguaggi case-sensitive come C evitare di usare nomi come counter e Counter. Esempi di nomi che "auto-definiscono" una variabile possono essere (sintassi PHP): $numColonne, $totUtenti, $connessione, $counter.

Ovviamente ognuno avrà poi una regola "preferita". Ricordare comunque che semplice = bello.

4. Le funzioni
Per le funzioni, classi o comunque blocchi di codice molto definiti oppure "importanti" è molto utile inserire un'intestazione formata da un commento contenente:

• Il prototipo della funzione / classe
• Una breve descrizione della funzione / classe

Spiegazione dettagliata degli eventuali parametri accettati, con esempi

5. La struttura dei files
In particolar modo per progetti che richiedono diversi tipi di files, come ad esempio i siti web, è consigliabile raggruppare i files di tipo simile (CSS, JS, ecc...) così da poter poi distinguere a colpo d'occhio i files e averli già raggruppati, qualora ci fosse bisogno di dover eseguire operazioni di tipo batch.

Ovviamente questa non vuole essere una bibbia e non è sicuramente esaustiva. Ognuno può trovare le tecniche o le scorciatoie che più gli si addicono. L'importante è andare fieri di quello che si fa e di come lo si fa, anche avendo cura delle persone che poi potrebbero dover revisionare o modificare il lavoro fatto.

... reading the UNIX source code to the Bourne shell (/bin/sh). I was shocked at how much simple algorithms could be made cryptic, and therefore useless, by a poor choice of code style. I asked myself, "Could someone be proud of this code?"

Landon Noll