Utilizzare i commenti nel codice

Quando cominciamo a scrivere del codice per sviluppare le nostre applicazioni, che si tratti di HTML, di PHP, Javascript o CSS non importa, non sempre ricordiamo di utilizzare costantemente i commenti.

Cosa sono i commenti

Si tratta semplicemente di appunti, che possono essere utili per noi, quando a distanza di settimane, andiamo a rivedere il codice di uno script o di un foglio di stile utilizzato per il sito di un cliente.

Se lavoriamo in un’agenzia oppure condividiamo il nostro lavoro con persone che fanno una revisione dei nostri progetti diventa fondamentale commentare.

Basta parole, vediamo in pratica come si utilizzano analizzandoli uno per uno, a secondo dei linguaggi che siamo abituati a scrivere.

I commenti in HTML

I commenti scritti in HTML si presentano, più o meno, così:

<!-- Header -->
	<div class="header">
		<p>
			Lorem ipsum dolor sit amet, consectetur adipisicing elit. Atque, veritatis.
		</p>
	<!-- fine Header -->

Come vedete, basta inserire il commento all’interno dei tag

<!-- e -->

I commenti in CSS

Diversa è la sorte per i commenti in CSS, in questo caso utilizzeremo il forward-slash e l’asterisco:

/* Quello che segue è lo stile del
   paragrafo */

   p {
   	text-align: center;
   	padding: 0 20px;
   	margin-left: 20px;
   	text-transform: uppercase;
   }

I commenti in PHP

Anche PHP utilizza lo stesso metodo dei CSS, ma integra questa possibilità con il doppio forward-slash per i commenti a linea singola, così:

<?php
	// Questo è un commento a riga singola in PHP

	/* Questo è un esempio di commento multi-riga in
	   PHP */
	$array = array('Mela', 'Banana', 'Arancia', 'Fragola');
	echo implode(' | ', $array);

?>

I commenti in Javascript

Anche Javascript fa suo il doppio stile nei commenti:

// Questo è un commento a riga singola in Javascript

document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";


/* Commento a riga multipla: in questo caso
   posso scrivere più righe senza interferire con il
   codice sottostante */
var x = 5;
var y = x + 2;

Insomma, tutti i linguaggi di programmazione (un po’ come facciamo quando scriviamo un appunto) ci danno la possibilità di commentare il codice che abbiamo scritto, sia per noi o per un collaboratore.

Non sottovalutate mai questa opportunità, a distanza di mesi o di settimane tornerà utile per voi o per chi lavora con voi,