Il markup HTML correttamente commentato è una parte importante di una pagina web ben strutturata. Questi commenti sono facili da aggiungere e chiunque debba lavorare sul codice di quel sito in futuro (incluso te stesso o membri di qualsiasi team con cui lavori) ti ringrazierà per questi commenti.
Come aggiungere commenti HTML
L'HTML può essere creato con un editor di testo standard, come Notepad ++ per Windows o TextEdit per un Mac. Puoi anche utilizzare un programma incentrato sul design web come Adobe Dreamweaver o persino una piattaforma CMS come Wordpress o ExpressionEngine. Indipendentemente dallo strumento che usi per creare l'HTML, se stai lavorando direttamente con il codice, devi aggiungere commenti HTML come questo:
-
Aggiungi la prima parte del tag di commento HTML:
-
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 vedrà l'origine della pagina web o aprirà l'HTML in un editor per apportare alcune modifiche. Tuttavia, il testo di un commento non verrà visualizzato nel browser Web quando un normale visitatore accede al sito. A differenza di altri elementi HTML, inclusi paragrafi, intestazioni o elenchi, che influiscono effettivamente sulla pagina all'interno di tali browser, i commenti sono in realtà parti "dietro le quinte" della pagina.
Commenti per scopi di prova
Poiché i commenti non compaiono in un browser Web, possono essere utilizzati per "disattivare" parti di una pagina durante il test o lo sviluppo delle pagine. Se aggiungi la parte di apertura di un commento direttamente prima della parte della pagina o del codice che desideri nascondere, quindi aggiungi la parte finale alla fine di quel codice (i commenti HTML possono estendersi su più righe, quindi puoi aprire un commenta la riga 50 del tuo codice e chiudila sulla riga 75 senza problemi), quindi qualsiasi elemento HTML che rientra in quel commento non verrà più visualizzato nel browser. Rimarranno nel codice, ma non influenzeranno la visualizzazione della pagina. Se hai bisogno di testare una pagina per vedere se una certa sezione sta causando problemi, ecc., È preferibile eliminarla. Con i commenti, se la sezione del codice in questione si dimostra non essere il problema, è possibile rimuovere facilmente i pezzi di commento e tale codice verrà visualizzato ancora una volta. Basta essere sicuri che questi commenti che vengono utilizzati per il test non si trasformino in 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 grande uso dei commenti HTML durante lo sviluppo è quando si costruisce un sito Web reattivo. Poiché diverse parti di quel sito cambieranno il loro aspetto in base a diverse dimensioni dello schermo, incluse alcune aree che potrebbero non essere visualizzate affatto, usare i commenti per attivare o disattivare le 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 al fine di ridurre le dimensioni di tali file e creare pagine più veloci. Mentre sono d'accordo sul fatto che le pagine dovrebbero essere ottimizzate per le prestazioni e dovrebbero caricarsi rapidamente, c'è ancora spazio per l'uso intelligente dei commenti nel codice. Ricorda, questi commenti hanno lo scopo di rendere più facile il lavoro su un sito in futuro, quindi fino a quando non lo si fa attendere con i commenti aggiunti a ogni riga del codice, la piccola quantità di dimensione del file aggiunta a una pagina a causa di i commenti dovrebbero essere più che accettabili.
Suggerimenti per l'utilizzo dei commenti
Alcune cose da ricordare 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.
- Commenti che le aree di "disattivazione" di un sito non dovrebbero essere messe in produzione a meno che questa modifica non sia temporanea e verrà invertita in breve tempo (come avere un messaggio di avviso attivato o disattivato secondo necessità).