Kommentaarid html-is ja php-s. Kommentaarid HTML-is, CSS-is, PHP-s

25.04.2017

Tere kõigile!
Jätkame PHP põhitõdede õppimist nullist!
Selles õppetükis räägin teile, mis on kommentaar PHP-s ja praktikas proovime teie kommentaari koodi sisse kirjutada. Kuid see pole veel kõik. Samuti tahan teile rääkida, kuidas koodi kommenteerida ja miks seda üldse teha tuleks.

Milles on kommentaarPHP
KommenteerigePHP on php-arendaja vihje nii koodis kiireks orienteerumiseks kui ka redigeerimiseks.

PHP-s olev kommentaar ei ole nähtav kasutajale, kes avas veebilehe vaatamiseks. Isegi kui kasutaja otsustab vaadata lehe lähtekoodi, pole kommentaar ikkagi nähtav, kuna kõik php.

PHP koodi kommentaar

PHP-koodi jaoks on kahte tüüpi kommentaare:

→ ühekihiline
→ mitmerealine

⇒ Üherealine kommentaar PHP jaoks
Üherealise kommentaari jaoks kasutage märke "//" või "#"

Pärast neid märke ignoreeritakse kõike, mis on kirjutatud ühele reale, ja käsitletakse kommentaarina.

Telli värskendamiseks"; # tellige (see on kommentaar) ?>

Tellige värskendus

⇒ Mitmerealine kommentaar PHP jaoks
PHP mitmerealine kommentaar algab tähega "/*" ja lõpeb tähega "*/".
Midagi nende märkide vahel ignoreeritakse ja käsitletakse kommentaarina.
Mitmerealist kommentaari kasutatakse juhul, kui kirjes on mitu rida.

Ekraanil näete ainult järgmist teksti:

Tere ajaveebi lugejad - saidi !!!

P.S.: Kommenteerige alati oma koodi. Kui arvate, et mäletate kõike, mida koodis tegite 1-2 aasta pärast, siis eksite, võimalus on väga väike. Isegi kui mäletate, peate kulutama palju aega õppimisele - mida, kus ja miks ...
Tee tulevik enda jaoks meeldivaks - kommenteeri kood välja ja siis ütled endale "AITÄH!!!".
Jäta koodi kommentaar, see võtab sinu ajast 1 minuti, kuid säästab tulevikus terve päeva.

Kommenteerige PHP koodi

Oletame, et kirjutasid php koodi, aga millegipärast pead koodist 2 rida eemaldama.
Ma ei kiirusta midagi koodist eemaldama, eriti kui see on php kood, siis ma parem kommenteerin seda. Ja äkki on vaja kood tagastada. Kommentaaride tühistamine on lihtsam kui koodi uuel viisil kirjutamine.

Kuidas koodi sisse kommenteeridaPHP
Näide üherealise kommentaariga:

Tellige värskendus"; ?>

Mitmerealise kommentaariga näide.

Autorilt: kommenteerimine on üks neid funktsioone, mida on lihtne rakendada. Samal ajal võivad need redigeerimiselemendid olla suureks kasuks arendajatele, kes edastavad koodi käest kätte. Täna saate teada, kuidas PhpStormis plokki kommenteerida. Programmi sisu kommenteerimisel võtame arvesse ka ülejäänud arenduskeskkonna funktsionaalsust.

Kommentaarid: hea ja halb

Koodi kommenteerimise võimalus on saadaval enamikus programmeerimiskeeltes (tõenäoliselt kõigis, kuid erineva kättesaadavuse astmega). Tavaliselt kasutatakse suulisi selgitusi selleks, et aidata teistel meeskonnaliikmetel edasi areneda või lihtsalt meelde tuletada, et see valdkond vajab parandamist (“FIX ME”).

Kirjutatu selgitus on muidugi õnnistuseks. Kuid kommentaaride abil saab koodi kõik head küljed maha kriipsutada. Selle vältimiseks on vaja eristada kommentaaride tüüpe:

dokumenteerimine. Hea seos oleks erinevate tarkvarade dokumentatsiooni kontseptsioon. Sellised kommentaarid aitavad koodi kasutada, nagu juhised. Sellist kommenteerimist ei peeta üleliigseks, sest ilma selleta ei saa kuidagi. Kujutage ette, et keegi on kasutanud autoriraamistikku ega ütle teile, kuidas programmi kasutada;

JavaScript. Kiire algus

selgitav. Hea kood neid tavaliselt ei vaja. Mida rohkem rida kommentaare programmis näete, seda tõenäolisem on, et programm on halvasti kirjutatud. Muidugi pole see absoluutne reegel.

Selgitavad kommentaarid võivad olla kasulikud neile, kes tulevikus koodi parandavad. Näiteks paljud noored spetsialistid näevad igal pool arenguruumi. Nad usuvad, et enne neid oli kõik hullem ja nüüd on aeg parandada iga funktsiooni.

Mõnikord võidab sarnane tunne professionaale. Näiteks kui kõik tundub üllatavalt kõver - peab olema parem lahendus. Et jälgijad midagi paremat ei otsiks, võib programmeerija jätta sellise märkuse: #time_spent_here=24h

Pärast selliseid sõnu tahavad vähesed nii palju aega veeta. Seega hoiatate, et paljud erinevad võimalused on juba välja sorteeritud. Samal ajal peaksite vältima selliseid rünnakuid: #i_hate_this, #try_to_do_better_ass%%le. Sel moel näitate üles ainult ebaprofessionaalset suhtumist. Ära sea ennast ja tööandjat ohtu.

Kuid ka koodi kommenteerimise dokumenteerimine võib programmeerija jaoks saada ballastiks. Reeglina on need massiivsed lõigud, mis häirivad otse programmeerimisest. Kuid koodi kuvamiseks ilma kommentaarideta on peamistes IDE-des vastav funktsioon. Ei tohiks olla erand ja PhpStorm, kuid paraku. Otsige funktsiooni värskendusdokumentidest.

Märgi funktsionaalsuse elemendina

Kuigi kommenteerimine oli mõeldud selgituseks ja meeskonna arengu abistamiseks, ei kasutata neid funktsioone nii sageli. Reeglina asetatakse sildid sinna, kus nad tahavad koodi täitmise peatada. Oletame, et teil on HTML-i manustatud PHP. Ja te ei taha seda kustutada, vaid soovite lihtsalt näha, kuidas leht ilma selleta välja näeb. Selleks peate järgima järgmist süntaksit:

JavaScript

…

...

…< div > . . . < / div >

< ? -- закомментированныйкоднаphp -- >

< div > . . . < / div >

Nagu näete, saate lihtsate toimingute abil koodi täitmise peatada isegi keerulisi toiminguid tegemata. Kuid tegelikult pole see veel optimeerimise kõrgpunkt. Täiendavat mugavust arendajale pakub phpStorm IDE ise. Esiletõstmise ja kiirklahvide abil saate valitud koodisegmenti kommenteerida ilma spetsiaalseid silte määramata. Seda saab teha nii.

Valige teile sobival meetodil tekstiosa (hiir, otseteed).

Vajutage klaviatuuri otseteed Ctr + Tõstuklahv + /

Lisaks saate kommenteerida jooksvat rida. Kõik sama, ainult ilma Shiftita.

Seda tüüpi kommenteerimise eeliseks on mitme keele samaaegne katvus. PHP on iseenesest haruldane. Nii ei pea te igaüht sildistada. Keskkond toetab veel mitut veebikeelt. Valige lihtsalt fragment ja müüge kombinatsioon – see on mitmekeelne kood ja kommenteeritud. Samamoodi saab selle aktiivseks muuta.

See on kõik, mis meil on. Kui te pole neid funktsioone varem kasutanud, soovitame teil alustada. Lühendid muudavad töö kiiremaks ja paremaks.

JavaScript. Kiire algus

Õppige JavaScripti põhitõdesid veebirakenduse loomise praktilise näite abil

Kommentaarid PHP-s on sarnased HTML-is kasutatavatele kommentaaridele. PHP süntaksis algavad kommentaarid alati spetsiaalse märgijadaga ja tõlk ignoreerib nende erimärkide vahele ilmuvat teksti.

HTML-is on kommentaaride peamine eesmärk olla märkus arendajatele, kes saavad vaadata teie saidi lähtekoodi. PHP kommentaarid erinevad selle poolest, et neid ei kuvata külastajatele. Ainus viis PHP kommentaaride vaatamiseks on faili avamine redigeerimiseks. See muudab PHP kommentaarid kasulikuks ainult PHP programmeerijatele.

Kui unustasite või ei teadnud, kuidas HTML-is kommentaare tehakse, vaadake allolevat näidet.

php kommentaari süntaks: üherealine kommentaar

Kui html-il on ainult ühte tüüpi kommentaarid, siis PHP-l on kahte tüüpi. Esimene tüüp, mida arutame, on üherealine kommentaar. See tähendab, et kommentaar, mis käsib tõlgil ignoreerida kõike, mis juhtub sellel kommentaaridest paremal asuval real. Selle kommentaari kasutamiseks kasutage märke "//" või "#" ja PHP-tõlk ignoreerib kogu paremal olevat teksti.

Psst...Sa ei näe minu PHP kommentaare! // kaja "mitte midagi"; // kaja "Minu nimi on Humperdinkle!"; # echo "Ma ei tee ka midagi"; ?>

Tulemus:

Tere, Maailm! Psst...Te ei näe minu PHP kommentaare!

Pange tähele, et mitut meie kajakäsku ei töödeldud, kuna kommenteerisime neid spetsiaalsete kommentaarimärkidega. Seda tüüpi kommentaare kasutatakse sageli keeruka ja segatud koodi kiireks kirjutamiseks või PHP-koodi rea ajutiseks eemaldamiseks (silumise eesmärgil).

php kommentaari süntaks: mitmerealine kommentaar

Sarnaselt HTML-i kommentaaridega saab PHP-s mitmerealisi kommentaare kasutada suurte koodiplokkide kommenteerimiseks või mitmele reale kommentaaride kirjutamiseks. Mitmerealised kommentaarid PHP-s algavad tähega "/*" ja lõpevad tähega "*/". Midagi nende märkide vahel eiratakse.

Tulemus.

... täna oleme selles lühikeses, kuid kasulikus artiklis, selgitame välja, kuidas erinevaid programmikoode kommenteeritakse. Ma ei räägi palju, sest kui olete sellest huvitatud, siis olete selle ülesande küsimustega juba kokku puutunud ja teil on sellest ettekujutus.

Olete jõudnud õigesse kohta... aga paar sõna selguse ja kasulikkuse huvides. Olete kindlasti näinud, kuidas seda CSS-koodiga tehakse, kuna css pakub kõige enam huvi paljudele algajatele, nagu mina.

… Hea!

Kuid pange tähele, et ka kommentaare kasutatakse html ja php... Kuid enamik algajaid satub saidiga töötamise algfaasis segadusse ega tea, kuidas endale vajalikke selgitusi lisada. Lõppude lõpuks juhtub see samamoodi, näiteks peate mõneks ajaks deaktiveerima html kood, ja jätkake seejärel selle funktsiooniga uuesti – seda on lihtne rakendada, kui tegite "marginaalidele" märkmeid, kuid te ei tea kunagi, 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:hover, a:focus (värv: #D5071E; tekstidekoratsioon: ülejoon; /*allakriipsutamine*/ )

Nii selgitate ennast. Või üldiselt saate seda css-skripti kommenteerida järgmiselt: lihtsalt mähkige

/* KOOD siin */

/*a:hover, a:focus (värv: #D5071E; tekstidekoratsioon: allakriipsutus; /*ALUMINE ALLAJOON*/ )*/

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

Muidu tuleb viga!!

Märge:

Kui avate lehe lähtekoodi - Ctrl + U ja vaatate ... näeme, et kommenteeritud css-koodi tükk on loodud dokumendis suurepäraselt kuvatud! see on siis, kui css-i kasutati (omadused määrati) otse html-is

Ja nagu aru saate, kui järgite linki lähtekoodist oma aktiivse malli css-dokumendile, saate jälgida ja uurida kõiki kommentaare)), kui keegi seda vajab. Kuid see on ebatõenäoline.)

Inglise murre (sõnad) on loetav. Vene sümbolid - ei.

HTML-koodi kommenteerimine

XML-faili kommenteeritakse samamoodi.

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

Lihtne vormindamise hoolimatus võib maksta aega, näiteks ülaltoodud KOMMENTEERITUD kood on sageli vale: kahe lühikese sidekriipsu asemel ilmub kriips:

Sulle teadmiseks:

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

Pidage seda meeles.

Ja siin on veel midagi:

lisaks sellele, et kommenteeritud kood kuvatakse lehe lähtekoodis (ja seetõttu mõnes mõttes töödeldakse, kuigi see jääb lehel nähtamatuks!) - on parem eemaldada mõned php-funktsioonid koos html-iga aktiivsest dokumendist.

Näiteks:

on näha dokumendis ja funktsioonissee teeb oma tööd märkimisväärselt hästi: see tähendab, et esiotsas ei ole teave nähtav, kuid lähtekoodis kuvatakse see selgelt! ja see on bespontoov päring andmebaasile: see kõik on tühiasi, kuid sa pead teadma!

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

lisada enne vajalikku "ekstra" html koodi avamist… tekstisisene funktsioon… ja sulgemine?> …

Ühesõnaga, kui kood on suur, saate seda teha:

**/ ?>

siis on allikas puhas!

Või lihtsamalt:

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

kuidas javascripti kommenteerida

if (beingShown || Näidatakse) ( // ära käivita animatsiooni uuesti return; ) else ( // rakenda reale MIS TAHES KOMMENTAAR // rakenda reale MIS TAHES KOMMENTAARID // true;

See JavaScripti koodi näidis - selguse huvides haarasin võrgust, parandades veidi kirjavahemärke. Vahet pole... Peaasi on põhimõttest aru saada...

Nagu aru saate, on kaldkriips “//” kahekordne, see on kommentaari MÄRK ... ÜHEREANE!

Ja ülejäänud JS-koodi kommenteeritakse nagu php , selle kohta lähemalt allpool:

Märge: