Guida sugli stili da usare nella scrittura del codice per la programmazione web, PHP, JavaScript, CSS

Tutti i programmatori si chiedono quale sia lo stile migliore per scrivere il proprio codice. Per le variabili conviene usare il CamelCase oppure il trattino basso? Nel codice conviene usare lo stile Allman oppure quello Stroustrup? In questa guida vi presento il mio stile, maturato da anni di esperienza e soprattutto da molte "battaglie interiori" sul quale sia lo stile migliore.

Credo di avere trovato una tregua che dura ormai da un bel pò di tempo. Se anche voi vi trovate nella stessa situazione, prendetevi un pò di tempo per leggere questa piccola guida.

Diversi stili per diversi linguaggi

La tregua che ho trovato, sta nell'usare per ogni linguaggio uno stile diverso. Questa scelta oltre a calmare le mie "battaglie interiori", rende molto più facile la comprensione del codice. Nella programmazione web si ha spesso a che fare con codice PHP, codice JavaScript e anche stili CSS che magari sono tutti scritti nello stesso documento di codice. In questi casi e specialmente se il codice non lo avete scritto voi o se riprendete un vostro codice in mano dopo molto tempo, potreste fare confusione su quale parte del codice è PHP, quale JavaScript e a quale stile CSS ci si riferisce. Scrivere con stili diversi, codici di linguaggi diversi, rende molto più facile il loro riconoscimento e la loro comprensione.

Lo stile da usare per il codice PHP

Nel linguaggio PHP, per le variabili, consiglio di usare il trattino basso, per l'indentazione invece lo stile Allman. Questo è lo stile usato da CodeIgniter, un bellissimo Framework PHP, che io uso moltissimo nei miei progetti, in questa pagina potrete leggere in dettaglio gli stili che CodeIgniter raccomanda.

Un esempio di codice PHP con indentazione Allman e variabili con trattino basso:

if($trattino_basso) // variabile con trattino basso come separatore di parole
{ 
	// codice con stile Allman 
	// dove le parentesi graffe di apertura sono messe sempre in una nuova riga 
	// allo stesso livello dell'istruzione
	echo "Codice Allman";
}

Lo stile da usare per il codice JavaScript

Per le variabili consiglio di usare il CamelCase, per l'indentazione invece lo stile Stroustrup.

Un esempio di codice JavaScript con variabili in stile CamelCase e indentazione in stile Stroustrup:

if($camelCase) { // variabile con stile CamelCase come separatore di parole
	// codice con stile Stroustrup 
	// dove le parentesi graffe di apertura sono messe sempre nella stessa riga separati da uno spazio
	alert('Codice Stroustrup');
}

Lo stile da usare per gli stili CSS

Per il CSS consiglio di usare il trattino come separatore di parole, in questo modo i selettori CSS sono subito riconoscibili dal resto del codice.

Un esempio di selettori CSS con stile trattino:

.stili-generali { // selettore di classe con trattino come separatore di parole
	color: red;
}

#stile-singolo { // selettore di id con trattino come separatore di parole
	color: blue;
}

Un esempio di codice misto con PHP, JavaScript e CSS:

<style>
	.stili-generali {
		color: red;
	}
	#stile-singolo {
		color: blue;
	}
</style>
<?php
	if($trattino_basso)
	{ 
		echo '<input onclick="allertaTutti();" id="stile-singolo" type="button" value="Cliccami" />';
	}
?>
<script>
    function allertaTutti () {
		if($camelCase) {
			alert('Codice Stroustrup');
		}
	}
</script>

Come si può vedere dal codice qui sopra si riesce a colpo d'occhio avendo bene in mente i diversi stili capire quale è il codice PHP, quale quello JavaScript e quale parte è relativi agli stili CSS