Salta il menu

[codice] I commenti

Notizia del 25/11/2007

Mi capita spesso di annidare più div per ottenere un determinato effetto grafico e non sempre l'indentazione è sufficiente per racapezzarmici, soprattutto quando sono costretta a fare il lavoro in più giorni.

In questi casi, mi è molto utile il commento, che uso spesso soprattutto per segnalare le chiusure dei div:

<div id="primo"> <div id="secondo"> <p>bla bla bla</p> <!-- se modificato, aggiornare menu.html --> </div> <!-- fine div secondo --> </div> <!-- fine div primo -->

Il commento di html e xhtml infatti inizia con la sequenza di caratteri <!-- e termina con la sequenza di caratteri -->; nell'esempio usato la sua funzione non è molto evidente, ma se pensiamo a delle pagine lunghe, con molti annidamenti e molto codice in generale ci si rende conto che il commento diventa insostituibile.

Il commento può essere utile - in fase di revisione del file - per ricordarsi di apportare modifiche anche in un altro punto o in un altro file. Con questo sistema, si ha sempre sott'occhio la situazione e si corre meno il rischio di dimenticare qualche div aperto o qualche modifica necessaria.

***

Stessa cosa per i fogli di stile: a volte capita di crearne di molto lunghi e anche qui l'indentazione non è sufficiente, così con il commento si può creare una specie di "intestazione", che aiuta a ritrovare con un'occhiata la sezione che desiderata:

/******* sinistra *******/ div {border: 1px solid red;} /* bordo esterno */ p {text-align: left;} /******* destra *******/ div {border: 1px solid green;} p {text-align: right;}

Il commento vero e proprio inizia con i caratteri /* e termina con i caratteri */ come nel commento /* bordo esterno */, ma aggiungendo alcuni asterischi all'interno (generalmente ne aggiungo molti di più di quelli dell'esempio), si evidenzia la riga e quindi il cambio di sezione e si rende agevole leggere il css.

Come si può vedere, i due tipi di commento sono diversi, ogni linguaggio ha il proprio (alcuni usano il cancelletto, altri la doppia slash), ma l'uso è lo stesso e il consiglio è servirsene, perché davvero i commenti facilitano la vita, soprattutto quando si deve andare a modificare files risalenti a tempo prima oppure quando si lavora in team.

Nei due esempi riportati - commenti di html/xhtml e commenti di css - l'apertura e la chiusura possono essere fatti su due righe diverse: tutto quanto contenuto tra l'apertura e la chisura risulterà "commentato", invece per altri linguaggi ogni riga dev'essere commentata per conto proprio e a volte in questo caso non è richiesta la chiusura del commento stesso.

Note:

  1. oltre ai commenti, mi aiuto molto anche con gli spazi tra i blocchi di codice; anche se aggiungono peso alla pagina, si tratta comunque di pochi bit e non vale la pena di impazzire su codice appiccicato per risparmiarli;
  2. a volte si usano i commenti anche per rimuovere momentaneamente una parte di codice, senza cancellarla del tutto.

Torna a inizio pagina

Commenti

Non ci sono ancora commenti a questa news!

Aggiungi il tuo commento

I campi con * sono obbligatori.

Torna a inizio pagina

Torna a inizio pagina