Oikein kommentoitu HTML-merkintä on tärkeä osa hyvin rakennettu web-sivua. Näitä kommentteja on helppo lisätä, ja kenen täytyy työskennellä kyseisen sivuston koodilla tulevaisuudessa (mukaan lukien sinä tai minkä tahansa työryhmän jäsenet) kiittää sinua näistä kommenteista.
Miten lisätä HTML-kommentteja
HTML: ää voidaan kirjoittaa tavallisella tekstieditorilla, kuten Notepad ++ for Windows tai TextEdit for a Ma. Voit myös käyttää web-suunnittelupainotteista ohjelmaa, kuten Adobe Dreamweaver tai jopa CMS-alustaa, kuten Wordpress tai ExpressionEngine. Riippumatta työkalusta, jota käytät kirjoittajan HTML-koodeihin, jos työskentelet suoraan koodin kanssa, lisäät tällä tavoin HTML-kommentit:
- Lisää HTML-komentotunnuksen ensimmäinen osa:
- Tämän kommentin avaamisen jälkeen kirjoitat tekstin, jonka haluat nähdä tämän kommentin kohdalla. Tämä on todennäköisesti tulevaisuuden ohjeita kehittäjälle tai muulle kehittäjälle. Jos esimerkiksi haluat määrittää, missä tietyssä osassa sivua alkaa tai päättyy merkinnässä, voit kommentoida yksityiskohtia.
- Kun kommenttisi teksti on valmis, sulje kommenttimerkki, kuten tämä: ->
- Näin ollen kommenttisi näyttää kaiken kaikkiaalta:
Kommenttien näyttö
Kaikki HTML-koodiin lisättävät kommentit näkyvät kyseisessä koodissa, kun joku tarkastelee verkkosivun lähdettä tai avaa HTML: n editorissa tekemään joitain muutoksia. Tämä kommentti teksti ei kuitenkaan näy verkkoselaimessa, kun normaalit kävijät tulevat sivustoon. Toisin kuin muut HTML-elementit, kuten kappaleet, otsikot tai luettelot, jotka vaikuttavat todellisuudessa sivuihin selaimissa, kommentit ovat todella "kulissien takana" sivun kappaletta.
Comments for Testaustarkoituksia
Koska kommentit eivät näy verkkoselaimessa, niitä voidaan käyttää "sivun" osittaisen poistamiseen sivun testauksen tai kehityksen aikana. Jos lisäät kommentin avausosan suoraan ennen sivusi / koodin osaa, jonka haluat piilottaa, lisää sitten sulkemisosa kyseisen koodin lopussa (HTML-kommentit voivat sisältää useita rivejä, joten voit avata kommentoida koodisi viivaa 50 ja sulje se rivillä 75 ilman ongelmia), minkä tahansa HTML-elementit, jotka kuuluvat tähän kommenttiin, eivät enää näy selaimessa. Ne pysyvät koodissasi, mutta eivät vaikuta sivun visuaaliseen näyttöön. Jos haluat testata sivun nähdäksesi, onko jokin osio aiheuttanut ongelmia jne., On tärkeää, että kyseinen alue poistetaan sen poistamisesta. Kommenteilla, jos kyseessä olevan koodin osa ei näytä olevan ongelma, voit helposti poistaa kommentointikappaleet ja että koodi näytetään uudelleen. Vain olla varma, että nämä testauksessa käytetyt kommentit eivät tule tuotanto-sivustoihin.
Jos sivun aluetta ei näytetä, haluat poistaa koodin, ei vain kommentoida sitä, ennen kuin aloitat kyseisen sivuston.
Yksi HTML-kommenttien suuri käyttö kehitystyön aikana on, kun rakennat reagoivaa verkkosivustoa . Koska sivuston eri osat muuttavat ulkonäköään erilaisten näytön koon mukaan , mukaan lukien jotkut alueet, joita ei ehkä näytetä ollenkaan, käyttämällä kommentteja sivun osioiden siirtämiseen tai poistamiseen voi olla nopea ja helppo temppu käyttää kehityksen aikana.
Suorituskykyä
Olen nähnyt, että jotkut web-ammattilaiset ehdottavat, että kommentit olisi poistettava HTML- ja CSS-tiedostosta, jotta kyseisten tiedostojen kokoa voitaisiin pienentää ja luoda nopeammin ladattavia sivuja. Vaikka olen samaa mieltä siitä, että sivut pitäisi optimoida suorituskyvylle ja niiden pitäisi ladata nopeasti, koodin komentojen älykkäästä käytöstä on vielä paikka. Muista, että näiden kommenttien tarkoituksena on helpottaa sivuston työskentelyä tulevaisuudessa, niin kauan kuin et myöhässä sitä koodin jokaisella rivillä lisättyihin kommentteihin, sivuille lisätty pieni tiedostokoko kommentit pitäisi olla enemmän kuin hyväksyttäviä.
Vinkkejä kommenttien käyttämiseen
Joitakin asioita, jotka kannattaa muistaa tai muistaa, kun käytät HTML-kommentteja:
- Kommentit voivat olla useita rivejä.
- Käytä kommentteja dokumentin kehittämiseen.
- Kommentit voi; niin asiakirjan sisältöä, taulukon rivejä tai sarakkeita, seurata muutoksia tai mitä haluat.
- Huomautuksia, että sivuston "pois päältä" -alueet eivät saisi tehdä tuotannon, ellei tämä muutos ole tilapäinen, joka käännetään lyhyessä järjestyksessä (kuten jos hälytysviesti on otettu käyttöön tai pois päältä tarvittaessa).