Kommenteerib HTML-, CSS-, JS- ja PHP -koodi. Kuidas koodi HTML -i kommentaare kirjutada? Kuidas html -s selgitust teha

... täna selgitame selles lühikeses, kuid kasulikus artiklis, kuidas erinevat programmi koodi kommenteeritakse. Ma ei ütle palju, sest kui olete sellest huvitatud, olete selle probleemi küsimustega juba silmitsi seisnud ja teil on sellest ettekujutus.


Olete jõudnud aadressile ... kuid paar sõna selguse ja juhtumi kasulikkuse huvides. Olete ilmselt näinud, kuidas seda CSS -koodiga tehakse, kuna css pakub huvi paljudele algajatele, nagu mina.

… Hea!

Kuid pange tähele, et ka kommentaare kasutatakse html ja php... Kuid enamik algajaid satuvad saidiga töötamise algfaasis segadusse ega tea, kuidas vajalikke selgitusi endale lisada. Lõppude lõpuks juhtub see nii, et peate näiteks deaktiveerima html -kood, ja siis taas oma funktsiooni jätkama - seda on lihtne rakendada, kui olete teinud endale märkmeid "äärealadele", kuid kunagi ei tea, mida.

Kuid mida tuleks "kommentaaride" kohta üldiselt meeles pidada - siin sõltub kõik rangelt sellest, millise failiga konkreetselt töötate, ja seetõttu on rakenduse kood erinev.

CSS -koodi kommenteerimine

a: hõljutus, a: fookus (värv: # D5071E; teksti kaunistamine: ülejooneline; / * RÕHUTAGE ÜLES * /)

Nii seletad end endale. Või võite isegi kommenteerida seda css -skripti nii: lihtsalt mähkige

/ * KOODI siin * /

/ * a: hõljutage kursorit, a: fookust (värv: # D5071E; teksti kaunistamine: allajoonitud; / * ALLAJÄRGI * /) * /

Juhin teie tähelepanu asjaolule, et - saate css -koodi täielikku tsüklit sel viisil kommenteerida, kuid !! siis peate eemaldama korduvad kommentaarid / * ALATI ALATI * / või kaldkriipsudega mängima, kui selgitus on oluline))

Muidu tuleb viga !!

Märge:

Kui avate lehe lähtekoodi - Ctrl + U ja heidate pilgu ... näeme, et kommenteeritud css -kooditükk on genereeritud dokumendis ilusti kuvatud! seda juhul, kui kasutati css -i (atribuudid määrati) otse html -is

Ja nagu teate, kui lähtute lähtekoodist viitega oma aktiivse malli css -dokumendile - kõiki kommentaare saab jälgida ja uurida)), kui keegi seda vajab. Aga see on ebatõenäoline)

Inglise keele määrsõna (sõnad) on loetav. Vene sümboolika - ei.

HTML -koodi kommenteerimine

XML -faili kommenteeritakse samamoodi.

Tähtis: kontrollige alati artiklites toodud koodi, vähemalt visuaalselt), vastasel juhul võib esineda vigu.

Tavaline hooletus vormindamisel võib olla aeganõudev, näiteks ülaltoodud KOMMENTEERITUD kood on sageli ekslik: kahe lühikese sidekriipsu asemel kuvatakse kriips:

Sulle teadmiseks:

nagu eelmises märkuses mainitud - nii on ka kommentaar -out ... html -kood kuvatakse loodud dokumendis!

Pidage seda meeles.

Ja siin on veel üks asi:

lisaks sellele, et kommenteeritud kood kuvatakse lehe lähtekoodis (mis tähendab, et seda töödeldakse teatud mõttes, kuigi see jääb ka lehel nähtamatuks!) - parem on eemaldada mõned php -funktsioonid koos aktiivse dokumendi html -iga.

Näiteks:

on dokumendis ja funktsioonis nähtavsee saab oma ülesandega suurepäraselt hakkama: see tähendab, et teavet ei näe frontendis, vaid allikas - see kuvatakse selgelt! ja see on andmebaasi tellimine: see kõik on tühiasi, kuid peate teadma!

Seda on võimalik teha, kui te ei soovi dokumendist kooditükki välja võtta:

lisage ava enne vajalikku "ekstra" html -koodi... inline funktsioon ... ja sulgemine?> ...

Ühesõnaga, kui kood on suur, saate seda teha järgmiselt.


**/ ?>

siis on allikas puhas!

Või lihtsamalt:

Kommenteerime funktsiooni ennast html -dokumendis. Lähtekood on sellistel juhtudel funktsioonide arendamise osas puhas!

kuidas JavaScripti kommenteerida

if (beingShown || näidatud) (// ära käivita animatsiooni uuesti;) else (// real rakenda ANY COMMENT // real rakenda ANY COMMENT // true;

Selguse huvides haarasin selle näite JavaScripti koodi võrku, muutes kirjavahemärke pisut. Pole tähtis ... Peaasi on põhimõttest aru saada ...

Nagu aru saate, on kaldkriips "//" kahekordne, see on kommentaari MÄRGIS ... ÜKS LINE!

Ülejäänud JS -koodi kommenteeritakse nagu php, sellest lähemalt allpool:

Märkus:

PHP koodi kommenteerimine

... ja ... siin on see sama-kaldkriips-kaldkriips ... üherealine.

Kuid pange tähele, et seda saab märkida nagu CSS-koodi.

... või nii, et saate kommenteerida - üherealine võimalus, kui me ei kasuta enne kommenteeritavat rida mitte kahte, vaid BECAR (räsi):

... Loomulikult peate koodiahelas hoolikalt kommenteerima!

... või samamoodi - sarnane ülaltoodud näitega CSS -i kohta ... st. see / * kood * / kommenteerimisvalik töötab nii CSS kui ka JS koodide puhul!

Kuid sel viisil saate kommenteerida mahukamat selgitust PHP -koodile, kuskil selle peamiste näidete vahel ...

Võite ka niimoodi php -ahelates kommenteerida, kui kood on segatud ... php ja kuidagi html

Sarnane ülaltooduga:

Näiteks mingi funktsioon ... kusagil üldkoodis (või silmus html -s):- saate kommenteerida, st lisada oma silt järgmiselt:

või nii: üherealine võimalus ...

Intelligentsus:

php -koodi pole üheski lähtekoodis näha !! nähtav on ainult selle funktsionaalne tulemus - töötab!

Üldiselt on see kõik, millest tahtsin täna teatada!

Nüüd saate katsetada ... Palju õnne.

Ja muidugi lugege saidi artikleid ja tellige:
Jagan oma kibedat kogemust - mõningaid teadmisi teie magusa heaolu nimel))

... veebimeistrite linn Mikhalika.ru© - hõlpsalt WordPressiga

Michael 2016-05-05 1 HTML ja CSS 2

Kuidas koodi HTML -i kommentaare kirjutada?

Täna räägin teile, kuidas html -koodis kommentaare teha. Kommentaarid on väga kasulik asi. Need ei mõjuta mingil viisil koodi täitmist ja lehtede välimust ning neid ei saa ikka lehe lähtekoodis näha. Tegelikult saab kommentaare näha ainult faili redaktoris avades. Minu Notepad ++ -is on need roheliselt esile tõstetud.

Kuidas html -i kommentaare jätta?

Väga lihtne. Märgistuskeele kommentaari süntaks on järgmine:

Seega saate kommenteerida mitte ainult ühte rida, vaid ka mitut. Peamine asi, mida meeles pidada, on see- sulgemine. Sellise konstruktsiooni sees saate kasutada nii selgitavat teksti kui ka nurksulgudes olevaid silte, brauser ei loe neid.

Nagu ma ütlesin, on kommentaaril järgmised omadused:

  1. seda pole lehel näha
  2. ja ka lähtekoodis ei, aga ainult faili redigeerimisel
  3. brauser ei tööta mingil viisil kõiki sellesse paigutatud silte

Milleks see mõeldud on

Kommentaaride peamine eesmärk on aidata teisi arendajaid. Kodeerimisel saate selgesõnaliselt märkida, milline koodi osa moodustab päise ja milline osa põhiosa. Loomulikult oleksid kogenud kodeerijad selle ilma selgeks saanud, kuid koodi lugemine ja mõistmine paraneb endiselt. Ja ka kommentaarid aitavad inimestel, kes html -ist hästi aru ei saa, ju vähemalt natuke, et kirjutatust aru saada. Siin on näide nende kasutamisest:

Kommentaari teine ​​võimalik kasutusviis on mõne kooditüki muutmine mõneks ajaks passiivseks, kui te ei soovi seda kustutada, kuid peate selle täitmise kuidagi passiivseks muutma. Muide, see võib aidata tuvastada erinevaid paigutusvigu.

Üldiselt on iga veebiarendaja üks häid omadusi võime kirjutada ilusti kujundatud ja arusaadav kood. See tähendab, et peate kasutama taanet, näidates elementide pesastamist, vajadusel jätma ka kommentaare, eraldama dokumendi põhiosad reavahedega jne. Kõik see aitab neid, kes edaspidi koodi toimetavad, aga ka autorit ennast, kes ei kao oma loomingusse.

Alustan seda artiklit kommentaaride jaoks. Oletame, et arendate keerulise struktuuriga moodulit. Või teete paigutuse paljude elementide manustega. Sellistel juhtudel on kõige parem koodi mõned osad kuidagi märkida - selleks on kommentaarid.

Nüüd näitan üksikasjalikult nelja tüüpi kommentaare, täpsemalt kõiki nende tüüpe nelja erineva koodi jaoks.

HTML -i kommentaarid

HTML -märgisele kommentaari lisamiseks kasutage järgmist.

Kõik, mis nendes siltides on, pole ekraanil nähtav, kuid on lähtekoodis vaatamiseks saadaval.

Kommentaarid CSS -stiilides

CSS -stiilidele kommentaari lisamiseks kasutage järgmist.

Kõike, mis nendes siltides on, ei võeta stiilide moodustamisel arvesse, kuid see on stiilide failis vaatamiseks saadaval.

JavaScripti kommentaarid

JavaScripti kommentaaride lisamiseks on olemas nende kahte tüüpi.

Esimene tüüp:

// Tekst, kood või muu

Teine tüüp:

/ * Tekst, kood või muu * /

Skripti käivitamisel ei võeta arvesse kõike, mis nendes siltides on, kuid see on JavaScripti failis vaatamiseks saadaval.

Kommentaarid PHP -koodis

Sellel programmeerimiskeelel on erinevalt eelmistest 3 tüüpi kommentaare.

Esimene tüüp:

// Tekst, kood või muu

Teine tüüp:

/ * Tekst, kood või muu * /

Ja kolmas tüüp:

# Tekst, kood või muu

Kõike, mis nendes siltides on, ei võeta skripti täitmisel arvesse ja see on nähtav ainult PHP -failis endas.

Märge!

/ * / * Minu kood * / * /

annab teile vea.

Selles õppetükis räägin sellest, kuidas seda teha kommentaarid HTML -is, CSS -is, PHP -s... Kommentaarid on tekst, mis pole veebilehel nähtav. Neid kasutatakse veebimeistrite jaoks igasuguste selgituste, meeldetuletuste ja kirjelduste jaoks, mis võimaldab dokumenti struktureerida. Kommentaarid on koodi silumisel hädavajalikud, need võimaldavad teil kiiresti navigeerida veebilehe märgistusel ja leida vajaliku ploki. Sageli kasutatakse HTML -koodi silumiseks kommentaare. Näiteks võite ajutiselt kommenteerida teatud koodiplokki, et see ei töötaks, ja vajadusel saab seda hõlpsasti taastada.

HTML -i kommentaarid

HTML -is moodustatakse kommentaarid sümbolite abil:... Seega on nende sümbolite vaheline tekst kommentaar. Vaatleme näidet:

Kommentaarid CSS -is

CSS -i kommentaarid luuakse sümbolite abil: / * ja * /. Kommentaari loomiseks peate lihtsalt sisestama veebilehe koodi nende sümbolite vahele:

/ * Bloki algus koos stiilidega kehale * / body (taust: #efeded; font-family: Verdana, Helvetica, sans-serif; font-size: 12px; margin: 0px; polster: 0px;) / * Ploki lõpp keha stiilidega * /

PHP kommentaarid

PHP kommentaarid võivad olla ühe- või mitmerealised:

1) Üherealised kommentaarid PHP -s luuakse sümbolite abil: //. Peate selle sümboli rea ette panema ja seda kommenteeritakse. Seda võimalust kasutatakse juhul, kui kommentaar koosneb ainult ühest reast.

2) Mitmerealiste kommentaaride rakendamiseks kasutatakse järgmisi sümboleid: / * ja * /. See valik on kasulik, kui kommentaar hõlmab mitut rida.

Seega oleme õppinud tegema

Programmeerija töös tuleb pidevalt teha märkmeid kommentaaride näol, et kirjeldada osa koodist või märkidest tulevikuks. Igal keelel on oma süntaks, mistõttu on veebilehtede arendamisel levinud probleem teadmatus, kuidas HTML -i rida või lihtsalt väikest plokki korraga kommenteerida.

HTML -i kommentaarid

Veebilehe väljatöötamisel on mõnikord vaja mõnda koodi mõnda aega peita või teha programmeerijale märge. Et mitte kasutada täiendavaid rakendusi, näiteks osa koodi teisaldamist teise faili, peate teadma, kuidas HTML -is rida kommenteerida.

Erinevalt enamikust programmeerimiskeeltest ei ole HTML-il üherealise kommentaari loomiseks erifunktsiooni ega -märgendit. Kui teil on vaja "peita" ainult ühte rida või selle osa, peate kasutama klassikalist keele tööriistakomplekti. Siiski on selleks mitmeid viise.

Tavaline kommentaar

HTML -is on lihtsaim viis kooditüki kommenteerimiseks kasutada erimärgipaare. Enne kommentaari alustamist peate määrama "". Seega on kõik selle struktuuri sees olevad andmed lehe laadimisel kasutaja eest peidetud.

Tuleb märkida, et kommentaariga töötades peate olema äärmiselt ettevaatlik. Selle piire määratledes peate kontrollima, kas sinna on sattunud mõni ava- või sulgemismärgis, mille teine ​​osa on sellest välja jäänud - sel juhul on lehe laadimine vale. Samuti ei saa ühe kommentaari sisse luua veel mitut - selle kirjutise korral avab esimene signaal kommentaariosa lõpuni kogu järgmise peidetud teksti osa.

Allpool on näide õigest kirjapildist:

See on kommentaar.

Silt

HTML -is saate ridu kommenteerida ka spetsiaalse sildipaari abil - ... Sel eesmärgil on see spetsiaalselt keele süntaksisse lisatud, kuid enamik populaarseid brausereid seda ei toeta, välja arvatud Internet Explorer 8.0. Silt Kasulik, kui osa teavet tuleb peita ainult IE 8.0, 4.0 ja varasemate versioonide jaoks või ajutise lahendusena arenduse ajal. Konkreetne punkt on see, et saate koodi osa kommenteerida ainult lehe põhiosas, st märgendi sees .

Allolevas näites, kui leht laaditakse määratud brauserites, kuvatakse valge leht, teistes programmides kirjutatakse leht:

See on kommentaar

.

Ebatraditsiooniline lähenemine

Lisaks klassikalistele meetoditele saate koodi HTML -is kommenteerida, kasutades konkreetseid meetodeid. Lisaks HTML -i põhilistele keelestruktuuridele on lehe põhiosas sageli määratud skriptisildid ja stiililehtede sildid. Igal neist on ka oma kommentaaride määratlused.

Seega, kui lisate koodi vajaliku osa ühte määratud märgenditesse, saate selle sees HTML -lehel osa koodi kommenteerimiseks kasutada muid meetodeid. Selliseid meetodeid tänapäeva praktikas praktiliselt ei kasutata, kuid enesearendamiseks või vajadusel teksti võimaliku ilmumise lehel välistamiseks saab neid rakendada.

Skriptisildi või stiililehe kasutamisel võivad kommentaarid olla ühe- või mitmerealised. Esimesed on määratletud konstruktsiooniga "//", mis nende tegelaste kirjutamise hetkest kommenteerib ülejäänud rida. Koodi osa peitmiseks kasutage avamiseks süntaksi kirjeldust " / *" ja kommentaari sulgemiseks " * /". Kui sulgemiskonstruktsiooni ei kirjutata sümbolite "/ *" järel, kommenteeritakse kogu ülejäänud HTML -kood.

Esitatud näide näitab mittestandardse kommenteerimise viisi:

/*

Это комментарий.

*/