Commentato correttamente HTML il markup è una parte importante di una pagina web ben costruita. Questi commenti sono facili da aggiungere e chiunque debba lavorare sul codice di quel sito in futuro (incluso te stesso o i membri di qualsiasi team con cui lavori) ti ringrazierà per quei commenti.
Come aggiungere commenti HTML
L'HTML può essere creato con un editor di testo standard, come Notepad++ per Windows o TextEdit per Mac. Puoi anche utilizzare un programma incentrato sul web design come Adobe Dreamweaver o persino una piattaforma CMS come Wordpress o ExpressionEngine. Indipendentemente dallo strumento che utilizzi per creare HTML, se stai lavorando direttamente con il codice, aggiungeresti commenti HTML come questo:
Aggiungi la prima parte del tag di commento HTML:
Dopo il pezzo di apertura del commento, scrivi il testo che desideri venga visualizzato per questo commento. È probabile che queste siano istruzioni per il tuo o per un altro sviluppatore in futuro. Ad esempio, se vuoi designare dove una determinata sezione di una pagina inizia o finisce nel markup, puoi usare un commento per dettagliarlo.
Una volta che il testo del tuo commento è completo, chiudi il tag del commento in questo modo:
Quindi, in totale, il tuo commento sarà simile a questo:
È davvero così semplice.
La visualizzazione dei commenti
Tutti i commenti che aggiungi al tuo codice HTML appariranno in quel codice quando qualcuno visualizza la fonte della pagina web o apre l'HTML in un editor per apportare alcune modifiche. Tuttavia, il testo del commento non verrà visualizzato nel browser Web quando i normali visitatori accedono al sito. A differenza di altri elementi HTML, inclusi paragrafi, intestazioni o elenchi, che in realtà hanno un impatto sulla pagina all'interno di quei browser, i commenti sono davvero pezzi "dietro le quinte" della pagina.
Commenti a scopo di test
Poiché i commenti non vengono visualizzati in un browser Web, possono essere utilizzati per "disattivare" parti di una pagina durante il test o lo sviluppo della pagina. Se aggiungi la parte di apertura di un commento direttamente prima della parte della tua pagina/codice che desideri nascondere e poi aggiungi il parte di chiusura alla fine di quel codice (i commenti HTML possono estendersi su più righe, quindi puoi aprire un commento sulla riga 50 del tuo codice e chiudilo alla riga 75 senza problemi), quindi tutti gli elementi HTML che rientrano in quel commento non verranno più visualizzati nel browser. Rimarranno nel tuo codice, ma non influiranno sulla visualizzazione della pagina. Se hai bisogno di testare una pagina per vedere se una certa sezione sta causando problemi, ecc., è preferibile commentare quell'area piuttosto che eliminarla. Con i commenti, se la sezione di codice in questione si rivela non essere il problema, puoi rimuovere facilmente i pezzi di commento e quel codice verrà visualizzato di nuovo. Assicurati solo che questi commenti utilizzati per i test non vengano inseriti nei siti Web di produzione. Se un'area di una pagina non deve essere visualizzata, si desidera rimuovere il codice, non solo commentarlo, prima di avviare quel sito.
Un ottimo uso dei commenti HTML durante lo sviluppo è durante la costruzione un sito web reattivo. Perché diverse parti di quel sito cambieranno il loro aspetto in base a diverse dimensioni dello schermo, comprese alcune aree che potrebbero non essere visualizzate affatto, l'utilizzo di commenti per attivare o disattivare sezioni di una pagina può essere un trucco facile e veloce da utilizzare durante lo sviluppo.
Per quanto riguarda le prestazioni
Ho visto alcuni professionisti del web suggerire che i commenti dovrebbero essere rimossi dai file HTML e CSS per ridurre le dimensioni di quei file e creare pagine più veloci. Mentre sono d'accordo che le pagine dovrebbero essere ottimizzato per le prestazioni e dovrebbe caricarsi rapidamente, c'è ancora un posto per l'uso intelligente dei commenti nel codice. Ricorda, questi commenti hanno lo scopo di semplificare il lavoro su un sito in futuro, a patto di non esagerare con commenti aggiunti a ogni riga del codice, la piccola quantità di dimensione del file aggiunta a una pagina a causa dei commenti dovrebbe essere maggiore di accettabile.
Suggerimenti per l'utilizzo dei commenti
Alcune cose da tenere a mente o ricordare quando si utilizzano i commenti HTML:
- I commenti possono essere più righe.
- Usa i commenti per documentare lo sviluppo della tua pagina.
- I commenti possono anche documentare il contenuto, le righe o le colonne della tabella, tenere traccia delle modifiche o qualsiasi altra cosa desideri.
- I commenti che "disattivano" le aree di un sito non dovrebbero entrare in produzione a meno che questa modifica non sia un uno temporaneo che verrà annullato in breve tempo (come avere un messaggio di avviso attivato o disattivato come necessario).