Komentāri html un php. Komentāri HTML, CSS, PHP

25.04.2017

Sveiki!
Turpinām apgūt PHP pamatus no nulles!
Šajā nodarbībā pastāstīšu, kas ir komentārs PHP un praksē mēģināsim ierakstīt tavu komentāru kodā. Bet tas vēl nav viss. Es arī vēlos jums pastāstīt, kā komentēt kodu un kāpēc tas vispār būtu jādara.

Kas ir komentārsPHP
Ierakstiet komentāruPHP ir php izstrādātāja padoms ātrai orientācijai kodā, kā arī rediģēšanai.

Komentārs PHP nav redzams lietotājam, kurš atvēra tīmekļa lapu apskatei. Pat ja lietotājs nolemj apskatīt lapas avota kodu, komentārs joprojām nebūs redzams, jo visi php.

PHP koda komentārs

PHP kodam ir divu veidu komentāri:

→ viena starplikas
→ daudzrindu

⇒ vienas rindiņas komentārs PHP
Vienas rindiņas komentāram izmantojiet rakstzīmes "//" vai "#"

Pēc šīm rakstzīmēm viss, kas rakstīts vienā rindā, tiks ignorēts un apstrādāts kā komentārs.

Abonēt, lai atjauninātu"; # abonēt (tas ir komentārs) ?>

Abonējiet atjauninājumu

⇒ Daudzrindu komentārs PHP
Daudzrindu komentārs PHP sākas ar "/*" un beidzas ar "*/".
Jebkas starp šīm rakstzīmēm tiks ignorēts un uzskatīts par komentāru.
Vairāku rindu komentārs tiek izmantots, ja ierakstā ir vairākas rindiņas.

Ekrānā redzēsit tikai šādu tekstu:

Sveiki emuāra lasītāji - vietnes !!!

P.S.: Vienmēr komentējiet savu kodu. Ja domājat, ka pēc 1-2 gadiem atcerēsities visu, ko darījāt kodā, jūs maldāties, iespēja ir ļoti maza. Pat ja atcerēsities, jums būs jāpavada daudz laika, lai mācītos - ko, kur un kāpēc ...
Padariet nākotni sev patīkamu - iekomentējiet kodu un tad pateiksiet sev "PALDIES!!!".
Atstājiet komentāru kodā, tas aizņems 1 minūti jūsu laika, bet nākotnē tas ietaupīs veselu dienu.

Komentējiet PHP kodu

Pieņemsim, ka jūs uzrakstījāt php kodu, bet nez kāpēc jums ir jāizņem no koda 2 rindiņas.
Es nesteidzos kaut ko izņemt no koda, it īpaši, ja tas ir php kods, es to labāk komentēšu. Un pēkšņi būs jāatdod kods. Vieglāk ir atsaukt komentārus, nekā rakstīt kodu jaunā veidā.

Kā komentēt koduPHP
Piemērs ar vienas rindiņas komentāru:

Abonējiet atjauninājumu"; ?>

Piemērs ar vairāku rindiņu komentāru.

No autora: komentēšana ir viena no tām funkcijām, ko ir viegli ieviest. Tajā pašā laikā šie rediģēšanas elementi var būt ļoti noderīgi izstrādātājiem, kuri nodod kodu no rokas rokā. Šodien jūs uzzināsit, kā komentēt bloku programmā PhpStorm. Mēs apsvērsim arī pārējo izstrādes vides funkcionalitāti, lai komentētu programmas saturu.

Komentāri: labi un slikti

Iespēja komentēt kodu ir pieejama lielākajā daļā programmēšanas valodu (varbūt visās, bet ar atšķirīgu pieejamības pakāpi). Parasti verbālie paskaidrojumi tiek izmantoti, lai palīdzētu citiem komandas locekļiem turpināt attīstību vai vienkārši atgādinātu sev, ka šajā jomā ir nepieciešami labojumi (“FIX ME”).

Protams, rakstītā skaidrojums ir svētīgs. Bet ar komentāru palīdzību var izsvītrot visas labās koda puses. Lai tas nenotiktu, ir jānošķir komentāru veidi:

dokumentēšana. Laba asociācija būtu dažādas programmatūras dokumentācijas koncepcija. Šādi komentāri palīdz izmantot kodu, piemēram, norādījumi. Tāda komentēšana netiek uztverta kā lieka, jo bez tā nekādi nevar. Iedomājieties, ka kāds ir izmantojis autorēšanas sistēmu un nepasaka, kā lietot programmu;

JavaScript. Ātrs sākums

skaidrojošs. Labam kodam tie parasti nav vajadzīgi. Jo vairāk komentāru rindiņu redzat programmā, jo lielāka iespēja, ka programma ir slikti uzrakstīta. Protams, tas nav absolūts noteikums.

Tiem, kas turpmāk labos kodu, var noderēt paskaidrojoši komentāri. Piemēram, daudzi jaunie profesionāļi visur saskata iespējas uzlabot. Viņi uzskata, ka pirms viņiem viss bija sliktāk, un tagad ir pienācis laiks labot katru funkciju.

Dažreiz līdzīga sajūta pārņem profesionāļus. Piemēram, kad viss izskatās pārsteidzoši greizs – ir jābūt labākam risinājumam. Lai sekotāji nemeklētu kaut ko labāku, programmētājs var atstāt šādu piezīmi: #time_spent_here=24h

Pēc šādiem vārdiem daži cilvēki vēlas pavadīt tik daudz laika. Tādējādi jūs brīdināt, ka daudzas dažādas iespējas jau ir sakārtotas. Tajā pašā laikā jums vajadzētu izvairīties no šādiem uzbrukumiem: #i_hate_this, #try_to_do_better_ass%%le. Tādā veidā jūs izrādāt tikai neprofesionālu attieksmi. Nekompromitējiet sevi un darba devēju.

Bet koda komentēšanas dokumentēšana programmētājam var kļūt arī par balastu. Parasti tās ir milzīgas sadaļas, kas novērš uzmanību tieši no programmēšanas. Bet, lai parādītu kodu bez komentāriem, galvenajos IDE ir atbilstoša funkcija. Nevajadzētu būt izņēmumam un PhpStorm, bet diemžēl. Atjaunināšanas dokumentos meklējiet funkciju.

Atzīmē kā funkcionalitātes elementu

Lai gan komentēšana bija paredzēta kā precizējums un palīgs komandas attīstībā, šīs funkcijas netiek izmantotas tik bieži. Parasti tagi tiek novietoti tur, kur tie vēlas apturēt koda izpildi. Pieņemsim, ka jums ir HTML iegulta PHP. Un jūs nevēlaties to izdzēst, jūs vienkārši vēlaties redzēt, kā lapa izskatās bez tā. Lai to izdarītu, jums jāievēro šāda sintakse:

JavaScript

…

...

…< div > . . . < / div >

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

< div > . . . < / div >

Kā redzat, ar vienkāršām darbībām jūs varat apturēt koda izpildi, pat neveicot nekādas sarežģītas darbības. Bet patiesībā tas vēl nav optimizācijas augstums. Papildu ērtības izstrādātājam nodrošina pati phpStorm IDE. Izmantojot iezīmēšanu un īsinājumtaustiņus, varat komentēt atlasīto koda segmentu, nepiešķirot specializētus tagus. To var izdarīt šādi.

Izmantojot sev piemērotu metodi, atlasiet teksta daļu (pele, īsceļi).

Nospiediet īsinājumtaustiņu Ctr + Shift + /

Turklāt jūs varat komentēt pašreizējo rindu. Viss tas pats, tikai bez Shift.

Šāda veida komentēšanas priekšrocība ir vairāku valodu vienlaicīga pārklājums. PHP ir reti sastopams pats par sevi. Tādā veidā jums nav jāizmanto katra marķēšana. Vide atbalsta vēl vairākas tīmekļa valodas. Vienkārši atlasiet fragmentu un pārdodiet kombināciju - tas ir daudzvalodu kods un komentēts. Tādā pašā veidā to var aktivizēt.

Tas ir viss, kas mums ir. Ja iepriekš neesat izmantojis šīs funkcijas, iesakām sākt. Saīsinājumi padara darbu ātrāku un labāku.

JavaScript. Ātrs sākums

Apgūstiet JavaScript pamatus, izmantojot praktisku tīmekļa lietojumprogrammas izveides piemēru

Komentāri PHP ir līdzīgi komentāriem, ko izmanto HTML. PHP sintaksē komentāri vienmēr sākas ar īpašu rakstzīmju secību, un jebkuru tekstu, kas parādās starp šīm īpašajām rakstzīmēm, tulks ignorēs.

HTML valodā komentāra galvenais mērķis ir kalpot kā piezīme izstrādātājiem, kuri var skatīt jūsu vietnes avota kodu. PHP komentāri atšķiras ar to, ka tie netiks rādīti apmeklētājiem. Vienīgais veids, kā skatīt PHP komentārus, ir atvērt failu rediģēšanai. Tādējādi PHP komentāri ir noderīgi tikai PHP programmētājiem.

Ja esat aizmirsis vai nezināji, kā komentāri tiek veidoti HTML, skatiet tālāk redzamo piemēru.

php komentāru sintakse: vienas rindiņas komentārs

Kamēr html ir tikai viena veida komentāri, PHP ir divu veidu komentāri. Pirmais veids, ko mēs apspriedīsim, ir vienas rindiņas komentārs. Tas ir, komentārs, kas liek tulkam ignorēt visu, kas notiek šajā rindā pa labi no komentāriem. Lai izmantotu šo komentāru, izmantojiet rakstzīmes "//" vai "#", un PHP tulks ignorēs visu tekstu labajā pusē.

Psst...Jūs nevarat redzēt manus PHP komentārus! // atbalss "nekas"; // atbalss "Mani sauc Humperdinkls!"; # echo "Es arī neko nedaru"; ?>

Rezultāts:

Sveika pasaule! Psst...Jūs nevarat redzēt manus PHP komentārus!

Ņemiet vērā, ka vairākas mūsu atbalss komandas netika apstrādātas, jo mēs tās komentējām ar īpašām komentāru rakstzīmēm. Šāda veida komentāri bieži tiek izmantoti, lai ātri rakstītu par sarežģītu un neskaidru kodu vai īslaicīgi noņemtu PHP koda rindiņu (atkļūdošanas nolūkos).

php komentāru sintakse: daudzrindu komentārs

Līdzīgi kā HTML komentāri, daudzrindu komentārus PHP var izmantot, lai komentētu lielus koda blokus vai rakstītu komentārus vairākās rindās. Daudzrindu komentāri PHP sākas ar "/*" un beidzas ar "*/". Jebkas starp šīm rakstzīmēm tiks ignorēts.

Rezultāts.

... šodien mēs esam šajā īsajā, bet noderīgajā rakstā, mēs sapratīsim, kā tiek komentēti dažādi programmas kodi. Es daudz nerunāšu, jo, ja jūs tas interesē, tad jūs jau esat saskāries ar šī uzdevuma jautājumiem un jums ir priekšstats par to.

Jūs esat nonācis īstajā vietā... bet daži vārdi skaidrībai un lietderībai. Jūs noteikti redzējāt, kā tas tiek darīts ar CSS kodu, jo css visvairāk interesē daudzus iesācējus, piemēram, mani.

… Labi!

Taču ņemiet vērā, ka tiek izmantoti arī komentāri html un php... Bet vairums iesācēju sāk apjukt darba sākumposmā ar vietni un nezina, kā pievienot sev nepieciešamos paskaidrojumus. Galu galā tas notiek tāpat, piemēram, jums ir nepieciešams kādu laiku deaktivizēt html kods, un pēc tam atkal atsākt tās darbību — to ir viegli īstenot, ja veicat piezīmes par “maržām”, bet nekad nezināt, ko.

Bet kas būtu jāatceras par “komentāriem” kopumā - viss šeit ir stingri atkarīgs no tā, ar kuru failu jūs strādājat konkrēti, un tāpēc lietojumprogrammas kods ir atšķirīgs.

CSS koda komentēšana

a:hover, a:focus ( krāsa: #D5071E; teksta noformējums: pārslēgts; /*pasvītrojums augšpusē*/ )

Tā tu sevi izskaidro. Vai arī parasti varat komentēt šo css skriptu šādi: vienkārši iesaiņojiet

/* KODS šeit */

/*a:hover, a:focus ( krāsa: #D5071E; teksta noformējums: pasvītrojums; /*Apakšā pasvītrojums*/ )*/

Vēršu jūsu uzmanību, ka - šādi var komentēt pilnu css koda ciklu, bet !! tad jums būs jānoņem atkārtoti komentāri /* UNDERSTRING BELOW */ vai jāspēlē ar slīpsvītrām, ja paskaidrojums ir svarīgs))

Citādi būs kļūda!!

Piezīme:

Atverot lapas avota kodu - Ctrl + U un ieskatoties... mēs redzēsim, ka komentētā css koda daļa ir lieliski parādīta ģenerētajā dokumentā! tas ir, ja css tika izmantots (ir iestatīti rekvizīti) tieši html

Un, kā jūs saprotat, ja sekojat saitei no avota koda uz jūsu aktīvās veidnes css dokumentu, varat novērot un izpētīt visus komentārus)), ja kādam tas ir vajadzīgs. Bet tas ir maz ticams.)

Angļu valodas dialekts (vārdi) būs lasāms. Krievu simboli - nē.

HTML koda komentēšana

XML fails tiek komentēts tādā pašā veidā.

Svarīgi: vienmēr pārbaudiet rakstos piedāvāto kodu, vismaz vizuāli, pretējā gadījumā var būt kļūdas.

Vienkārša formatēšanas neuzmanība var maksāt laiku, piemēram, iepriekš redzamais KOMENTĒTAS kods bieži ir nepareizs: divu īsu defisu vietā parādās domuzīme:

Tavai zināšanai:

kā minēts iepriekšējā piezīmē - tāds ir arī komentārs ... ģenerētajā dokumentā tiek parādīts html kods!

Paturiet to prātā.

Un šeit ir vēl kaut kas:

papildus tam, ka komentētais kods tiek attēlots lapas avota kodā (un tāpēc savā ziņā tiek apstrādāts, lai gan tas lapā būs neredzams!) - labāk ir noņemt dažas php funkcijas kopā ar html no aktīvā dokumenta.

Piemēram:

būs redzams dokumentā un funkcijātas savu darbu veiks izcili labi: proti, priekšgalā informācija nebūs redzama, bet pirmkodā tā būs skaidri redzama! un tas ir bespontovy pieprasījums datu bāzei: tas viss ir sīkums, bet jums tas jāzina!

To var izdarīt, ja nevēlaties izņemt koda daļu no dokumenta:

pievienojiet pirms nepieciešamās "papildu" html koda atvēršanas… iekļauta funkcija… un aizvēršana?> …

Vārdu sakot, tas ir tas, ko varat darīt, ja kods ir liels:

**/ ?>

tad avots būs tīrs!

Vai vienkāršāk:

Komentēsim pašu funkciju html dokumentā. Pirmkods šajos gadījumos attiecībā uz funkciju izstrādi būs tīrs!

kā komentēt javascript

if (beingShown || parādīts) ( // neaktivizēt animāciju vēlreiz return; ) else ( // rindiņā lietot JEBKURU KOMENTĀRU // rindā lietot JEBKURU KOMENTĀRU // patiess;

Šis JavaScript koda paraugs — es skaidrības labad satvēru tīklu, nedaudz labojot pieturzīmes. Vienalga... Galvenais ir saprast principu...

Kā jūs saprotat, slīpsvītra "//" ir dubultā, šī ir komentāra ZĪME ... VIENRINDA!

Un pārējais JS kods tiek komentēts kā php, vairāk par to zemāk:

Piezīme: