Quando visualizzi una pagina web in un browser, stai visualizzando una rappresentazione visiva di ciò che quel pezzo di software (il browser web) sta visualizzando in base al codice di una determinata pagina web. Se visualizzi il codice sorgente della pagina web, vedrai un documento composto da vari elementi HTML, inclusi paragrafi, intestazioni, elenchi, collegamenti, immagini e altro ancora. Tutti questi elementi sono resi dal browser sullo schermo di un visitatore come parte della visualizzazione del sito web. Una cosa che puoi trovare nel codice HTML che non viene visualizzata sullo schermo di una persona sono i cosiddetti "commenti HTML".
Che cos'è un commento?
Un commento è una stringa di codice all'interno di HTML, XML o CSS che non viene visualizzata o gestita dal browser o dal parser. È semplicemente scritto nel codice per fornire informazioni su quel codice o altro feedback dagli sviluppatori del codice.
La maggior parte dei linguaggi di programmazione ha commenti, sono comunemente usati dallo sviluppatore del codice per uno o anche più di uno, per il seguente motivo:
- Descrivi e spiega il codice complicato a qualcuno che potrebbe dover lavorare su di esso in futuro, inclusi se stessi! Potrebbero tornare al codice 3 o 6 di 12 mesi o più tardi e non ricordare perché hanno fatto qualcosa in un certo modo. I commenti possono aiutare a rispondere alle loro domande e ricordare loro dove si trovavano le loro menti quando stavano sviluppando quella pagina.
- Fornire dettagli su quando il codice è stato modificato o revisionato. Questo può essere utile informazioni e agire in qualche modo come un registro di sviluppo di quando un sito è stato lavorato per l'ultima volta.
- Rimuovere sezioni del codice, ma lasciarle disponibili per un uso successivo. Questo è spesso fatto durante il test del sito e il debug. Se hai un problema su un sito e non sei sicuro di ciò che sta causando, puoi commentare le sezioni una alla volta per mettere in quarantena e identificare il problema, e poi lavorare su una correzione per qualunque problema tu stia riscontrando.
- Chatta con altri sviluppatori che lavorano sul codice. Questo probabilmente verrebbe fatto durante lo sviluppo come un modo per condividere i dettagli con altri che lavorano sul codice allo stesso tempo. Se questi commenti sono puramente conversazioni di sviluppo, è consigliabile rimuoverli dal codice prima che venga lanciato un sito.
Tradizionalmente, i commenti in HTML sono usati per quasi tutti gli elementi, dalle spiegazioni di strutture di tabelle complesse alle osservazioni informative del contenuto della pagina stessa. Poiché i commenti non vengono visualizzati in un browser, puoi aggiungerli ovunque nell'HTML e non preoccuparti di cosa farà quando il sito viene visualizzato da un cliente.
Come scrivere commenti
Scrivere commenti in HTML, XHTML e XML è molto semplice. Basta circondare il testo che vuoi commentare con il seguente:
e
Come puoi vedere, questi commenti iniziano con "meno di un simbolo", più un punto esclamativo e due trattini. Il commento termina con altri due trattini e un simbolo "maggiore di: tra questi caratteri puoi scrivere tutto ciò che vuoi per creare il corpo del commento.
Nei CSS, è un po 'diverso, usando i commenti del codice C piuttosto che l'HTML. Inizia con una barra diretta seguita da un asterisco. Si termina il commento con l'inverso di quello, un asterisco seguito da una barra in avanti.
I commenti sono un'arte che muore
La maggior parte dei programmatori conosce il valore di commenti utili. Il codice commentato facilita il trasferimento di quel codice da un membro del team a un altro. I commenti aiutano il team di QA a testare il codice perché possono dire cosa intendeva lo sviluppatore, anche se non è stato raggiunto. Sfortunatamente, con la popolarità delle piattaforme di authoring del sito come Wordpress, che ti permettono di essere attivo e in esecuzione con un tema scelto che gestisce molto, se non tutto, dell'HTML per te, i commenti non vengono usati spesso dai team web. Questo perché i commenti sono davvero difficili da vedere nella maggior parte degli strumenti di authoring visivo se non si sta lavorando direttamente con il codice. Ad esempio, piuttosto che vedere, nella parte superiore di una pagina web:
Lo strumento visivo mostra un'icona minuscola per indicare che c'è un commento. Se il designer non apre fisicamente il commento, potrebbe non vederlo mai. E nel caso della pagina precedente, potrebbe causare problemi se modifica la pagina e tale modifica è sovrascritta dallo script citato nel commento.
Cosa si può fare?
- Scrivi commenti significativi e utili. Non aspettarti che altre persone leggano i tuoi commenti se sono troppo lunghi o non includono informazioni utili.
- Come sviluppatore, dovresti sempre rivedere tutti i commenti che vedi in una pagina.
- Utilizzare gli strumenti forniti dai programmi di sviluppo che consentono di aggiungere commenti.
- Utilizza la gestione dei contenuti per controllare come vengono modificate le pagine.
Anche se sei l'unica persona che modifica le tue pagine web, i commenti possono essere utili. Se si modifica una pagina complicata solo una volta all'anno, è facile dimenticare come è stato costruito il tavolo o messo insieme il CSS. Con i commenti, non devi ricordare, perché è scritto proprio lì per te.
