Come scrivere commenti efficaci e perchè usarli

In questo articolo analizziamo la questione “commenti” durante la stesura del codice. Come ben sappiamo ritornare a lavorare sul codice (sia esso php,html o css), non è mai una cosa semplice, vediamo come scriverli in modo corretto e utile.

Ovviamente dipende dalla grandezza del progetto, ma in linea di massima, usare i commenti risulta molto utile nel caso dobbiate tornare a modificare il vostro sito (o porzioni dello stesso). Dopo mesi o magari anni, se non usate i commenti, passerete di sicuro almeno 30 min per “decodificare” nuovamente il codice, magari confondendovi o perdendovi letteralmente nel caos delle righe.

Esiste un metodo per ovviare a questo problema? la risposta è sì, e ovviamente ci vengono in aiuto i commenti. Questi “sconosciuti” sono usabili in tutti i linguaggi:

– html( <!–Commenti–> )

– CSS (/* Commenti */ )

– PHP/Javascript (//Commento)

Purtroppo però non basta “scrivere” parole a casaccio come fanno ormai, purtroppo, molti designer. Vediamo alcuni esempi:

SBAGLIATO:

<!--main-->

<div id="main">

[...]

</div>

CORRETTO:

<!--Inizio Main (960px centrato)-->

   <div id="main">

       [...]

         </div> <!--Fine Main-->

Cosa è cambiato? Bhè innanzitutto all’inizio del commento abbiamo specificato anche qualche attributo essenziale CSS, in modo che , se dovessimo ritornare, potremmo facilmente, e a colpo d’occhio, riconoscere a grandi linee il div ( nel nostro caso si evince che il div main e’ il contenitore principale con larghezza 960px centrato).

In secondo luogo abbiamo modificato l’indentatura, ovvero abbiamo “spostato” le varie righe in modo che siano più leggibili e ordinate. Questo, sopratutto per progetti lunghi e complessi, e’ essenziale. Sempre in ambito di leggibilità, ricordate di lasciare, possibilmente, sempre una linea di codice vuota tra un elemento e un altro. Non scrivete altresì i tag uno dietro l’altro, vi confonderebbero solamente.

Nel tag di chiusura, abbiamo specificato a cosa si riferisce, questo è molto importante per evitare i tag “orfani” di chiusura.

Consigli particolari per i CSS

I css richiedono uno spazio particolare. Vi consiglio caldamente di non lasciare gli attributi css su singola linea, oltre a risultare faticosi da leggere, potreste facilmente confondervi tra i vari tag.

Ecco un esempio per essere più chiari:

#switch2{ right:45%; top:55%; position:absolute;z-index:9999;cursor:pointer; display:none;}

Vedete come risulta “confuso”? immaginatevi stilizzazioni più complesse, la riga risulterebbe di difficile interpretazione.

Ecco invece come vi consiglio di fare:

 #switch2{
         position:absolute;
         right:45%; top:55%;
         z-index:9999;
         cursor:pointer;
         display:none;}

Ecco fatto! leggibile, ordinato e meno confuso!

Spero vi sia utile! ovviamente commentate!