Oikein kommentoitu HTML merkintä on tärkeä osa hyvin rakennettua verkkosivua. Nämä kommentit on helppo lisätä, ja kuka tahansa, joka joutuu työskentelemään kyseisen sivuston koodin parissa tulevaisuudessa (mukaan lukien itse tai minkä tahansa tiimin jäsenet, joiden kanssa työskentelet) kiittää sinua kommenteista.
HTML-kommenttien lisääminen
HTML: n voi laatia tavallisella tekstieditorilla, kuten Notepad ++ for Windows tai TextEdit for Mac. Voit käyttää myös verkkosuunnittelukeskeistä ohjelmaa, kuten Adobe Dreamweaver, tai jopa CMS-alustaa, kuten Wordpress tai ExpressionEngine. HTML-kirjoittajan käyttämästä työkalusta riippumatta, jos työskentelet suoraan koodin kanssa, voit lisätä HTML-kommentteja seuraavasti:
Lisää HTML-kommenttitagin ensimmäinen osa:
Kirjoita kommentin alkukappaleen jälkeen teksti, jonka haluat ilmestyä kommentille. Tämä on todennäköisesti ohjeita sinulle tai muulle kehittäjälle tulevaisuudessa. Esimerkiksi, jos haluat määrittää, missä sivun tietty osa alkaa tai päättyy merkinnällä, voit käyttää kommenttia sen yksityiskohtien selvittämiseen.
Kun kommenttisi teksti on valmis, sulje kommenttimerkki näin:
Joten kommenttisi näyttää tältä:
Se on todella niin yksinkertaista.
Kommenttien näyttö
HTML-koodiin lisäämäsi kommentit näkyvät siinä, kun joku tarkastelee verkkosivun lähdettä tai avaa HTML-editorin muutosten tekemiseksi. Kommenttiteksti ei kuitenkaan näy verkkoselaimessa, kun normaalit kävijät tulevat sivustolle. Toisin kuin muut HTML-elementit, mukaan lukien kappaleet, otsikot tai luettelot, jotka todella vaikuttavat sivuihin näiden selainten sisällä, kommentit ovat todella sivun "kulissien takana".
Kommentteja testaustarkoituksiin
Koska kommentteja ei näy verkkoselaimessa, niitä voidaan käyttää sivun osien "sammuttamiseen" sivutestauksen tai kehityksen aikana. Jos lisäät kommentin alkuosan suoraan ennen sivusi / koodisi osaa, jonka haluat piilottaa, ja lisäät sitten sulkeva osa koodin lopussa (HTML-kommentit voivat ulottua usealle riville, joten voit avata kommentin koodisi sanoriville 50 ja sulje se rivillä 75 ilman ongelmia), niin kaikki kommenttiin kuuluvat HTML-elementit eivät enää näy selain. Ne säilyvät koodissasi, mutta eivät vaikuta sivun visuaaliseen esitykseen. Jos haluat testata sivua sen selvittämiseksi, aiheuttaako tietty osio ongelmia jne., On suositeltavaa kommentoida kyseistä aluetta sen poistamisen sijaan. Kommenteilla voit poistaa kommenttikappaleet helposti, jos kyseinen koodiosio ei ole ongelma, ja koodi näkyy jälleen. Varmista vain, että nämä testauksessa käytettävät kommentit eivät pääse tuotantosivustoille. Jos sivun aluetta ei pitäisi näyttää, haluat poistaa koodin, ei vain kommentoida sitä, ennen kuin käynnistät kyseisen sivuston.
Yksi hyvä HTML-kommenttien käyttö kehityksen aikana on, kun rakennat reagoiva verkkosivusto. Koska kyseisen sivuston eri osat muuttavat ulkonäköään erikokoiset näytöt, mukaan lukien jotkut alueet, joita ei ehkä näytetä lainkaan, kommenttien käyttäminen sivun osien kytkemiseksi päälle tai pois päältä voi olla nopea ja helppo temppu kehityksen aikana.
Suorituskyvyn suhteen
Olen nähnyt joidenkin verkkoammattilaisten ehdottavan kommenttien poistamista HTML- ja CSS-tiedostoista, jotta ajettaisiin näiden tiedostojen koon pienentäminen ja nopeammin latautuvien sivujen luominen. Vaikka olen samaa mieltä siitä, että sivujen pitäisi olla optimoitu suorituskykyyn ja sen pitäisi latautua nopeasti, koodeissa on vielä paikka älykkäälle kommenttien käytölle. Muista, että näiden kommenttien on tarkoitus helpottaa sivuston käyttöä tulevaisuudessa, niin kauan kuin et liioittele sitä koodin jokaiselle riville lisättyjen kommenttien perusteella sivulle kommenttien vuoksi lisättävän pienen tiedostokoon tulisi olla yli hyväksyttävä.
Vinkkejä kommenttien käyttämiseen
Muutamia asioita, jotka on pidettävä mielessä tai muistettava käytettäessä HTML-kommentteja:
- Kommentit voivat olla useita rivejä.
- Dokumentoi sivusi kehitys kommenttien avulla.
- Kommentit voivat myös dokumentoida sisältöä, taulukon rivejä tai sarakkeita, seurata muutoksia tai mitä haluat.
- Kommentit, jotka "sammuttavat" sivuston alueet, eivät saisi tehdä siitä tuotantoa, ellei tämä muutos ole a väliaikainen, joka käännetään lyhyessä ajassa (kuten hälytysviesti päälle tai pois päältä nimellä tarvittu).