Mitä ovat HTML-kommentit ja miten niitä käytetään
a Kun katselet verkkosivua selaimessa, näet visuaalisen esityksen siitä, mitä ohjelmistoa (selaimella) näytetään tietyn verkkosivun koodin perusteella. Jos katsot verkkosivun lähdekoodia , näet asiakirjan, joka koostuu useista HTML-elementeistä, mukaan lukien kappaleet, otsikot, luettelot, linkit, kuvat ja paljon muuta. Kaikki nämä elementit ovat selaimen tekemiä kävijän näytöllä osana verkkosivuston näyttämistä. Yksi asia, jota voi löytyä HTML-koodista, jota ei ole tehty henkilön näytöllä, tunnetaan nimellä "HTML-kommentit".
Mikä on kommentti?
Kommentti on HTML-, XML- tai CSS-koodin merkkijono, jota selain tai jäsentimesi ei näe eikä toimi. Koodiin kirjoitetaan yksinkertaisesti koodia tai muuta palautetta koodin kehittäjiltä.
Suurin osa ohjelmointikieleistä on kommentteja, mutta koodin kehittäjä käyttää niitä usein tai useampaan seuraavista syistä:
- Kuvaile ja selitä monimutkaista koodia jollekin, joka joutuu työskentelemään sen tulevaisuudessa - mukaan lukien itse! He voivat palata koodiin 3 tai 6 12 kuukautta tai myöhemmin, eikä muista, miksi he tekivät jotain tiettyä tapaa. Kommentit voivat auttaa vastaamaan heidän kysymyksiinsä ja muistuttamaan heitä siitä, missä heidän mielensä oli, kun he ensin kehittivät kyseisen sivun.
- Anna tietoja siitä, milloin koodia on muokattu tai tarkistettu. Tämä voi olla hyödyllistä tietoa ja toimia jonkin verran kuin kehityskirjaa, kun sivustoa viimeksi työskennellyt.
- Poista koodin osat, mutta jätä ne myöhempää käyttöä varten. Tämä tehdään usein sivuston testauksen ja virheenkorjauksen aikana. Jos sinulla on ongelma sivustossa ja et ole varma, mikä aiheuttaa sen, voit kommentoida osiota yksi kerrallaan, jotta voit kartoittaa ja tunnistaa ongelman. Tee sitten korjaus ongelmista, joita sinulla on.
- Keskustele muiden kehittäjien kanssa, jotka työskentelevät koodilla. Tämä tapahtuisi todennäköisesti kehitysvaiheessa tapa jakaa yksityiskohtia muiden koodilla työskentelevien kanssa samanaikaisesti. Jos nämä kommentit ovat puhtaasti kehityskeskusteluja, on hyvä käytäntö poistaa ne koodista ennen sivuston käynnistämistä.
Perinteisesti HTML-kommentteja käytetään lähes kaikissa elementeissä, monimutkaisten taulukkorakenteiden selityksistä itse sisällön informatiivisiin huomautuksiin. Koska kommentit eivät ole selaimessa, voit lisätä ne mihin tahansa HTML-muotoon, eikä ole huolissasi siitä, mitä se tekee, kun asiakas tarkastelee sivustoa.
Miten kirjoittaa kommentteja
Kommenttien kirjoittaminen HTML-, XHTML- ja XML-tiedostoihin on erittäin helppoa. Yksinkertaisesti ympäröivä teksti, jonka haluat kommentoida, seuraavalla tavalla:
ja ->Kuten näette, nämä kommentit alkavat "pienemmällä kuin symbolilla", plus huutomerkki ja kaksi viivaa. Kommentti päättyy kahdella viivalla ja "suurempi kuin: symboli". Näiden merkkien välillä voit kirjoittaa mitä haluat kommentoidaksesi.
CSS: ssä se on hieman erilainen, kun käytät C-koodin kommentteja HTML: n sijaan. Aloitetaan eteenpäin viivalla ja tähdellä. Lopetat kommentoinnin sen käänteisellä, tähdellä ja eteenpäin viivalla.
/ * kommentoitu teksti * /Kommentit ovat kuolevaa taidetta
Useimmat ohjelmoijat tietävät hyödyllisten kommenttien arvosta. Kommentoidut koodit helpottavat koodin siirtämistä joukkueen jäseneltä toiseen. Huomautukset auttavat sinua QA-tiimin testaamaan koodia, koska he voivat kertoa, mitä kehittäjä on suunnitellut - vaikka sitä ei saavutettaisi. Valitettavasti sivuston luomisfoorumien, kuten WordPressin, suosion avulla, jonka avulla pääset käsiksi valitsemaan teeman, joka käsittelee paljon, ellei kaikkia HTML-koodia, kommentit eivät ole käytössä niin usein kuin WWW-ryhmät. Tämä johtuu siitä, että kommentit ovat todella vaikeita nähdä useimmissa visuaalisissa kirjoitustyökaluissa, jos et työskentele suoraan koodin kanssa. Esimerkiksi verkkosivun yläreunassa ei näy esimerkiksi:
Visuaalinen työkalu näyttää pienen kuvakkeen, joka ilmaisee, että kommentti on olemassa. Jos suunnittelija ei aio kommentoida fyysisesti, hän ei ehkä koskaan näe sitä. Ja edellä mainitun sivun tapauksessa voi aiheuttaa ongelmia, jos hän muokkaa sivua ja että muokkaus on ylikirjoitettu kommentissa mainittuun käsikirjoitukseen.
Mitä voidaan tehdä?
- Kirjoita mielekkäitä ja hyödyllisiä kommentteja. Älä odota muiden ihmisten lukea kommentteja, jos he ovat liian kauan tai eivät sisällä hyödyllisiä tietoja.
- Kehittäjänä sinun on aina tarkistettava kaikki sivullasi näkyvät kommentit.
- Käytä kirjoitinohjelmien tarjoamia työkaluja, joiden avulla voit lisätä kommentteja.
- Sisällönhallinnan avulla voit hallita sivujen muokkaamista.
Vaikka olet ainoa, joka muokkaa verkkosivuja, kommentit voivat olla hyödyllisiä. Jos muokkaat vain monimutkaista sivua kerran vuodessa, on helppo unohtaa, kuinka olet rakentanut taulukon tai asentanut CSS: n. Kommenteilla, sinun ei tarvitse muistaa, koska se on kirjoitettu sinne.
Alkuperäinen artikkeli Jennifer Krynin. Julkaisija Jeremy Girard 5/5/17