PHP-kommentti vaaditussa osiossa. Kommentit HTML, CSS, PHP

Kirjailijalta: Kommentointi on yksi niistä ominaisuuksista, jotka on helppo ottaa käyttöön. Samaan aikaan nämä muokkauselementit voivat tuoda paljon etuja kehittäjille, jotka siirtävät koodia kädestä toiseen. Tänään opit kommentoimaan lohkoa PhpStormissa. Otamme huomioon myös kehitysympäristön jäljellä olevat toiminnot ohjelman sisällön kommentoimiseen.

Kommentit: huono ja hyvä

Mahdollisuus kommentoida koodia on saatavilla useimmilla ohjelmointikielillä (ehkä kaikilla, mutta vaihtelevalla saavutettavuusasteella). Tyypillisesti sanallista selvennystä käytetään auttamaan muita tiimin jäseniä kehittymään edelleen tai yksinkertaisesti muistuttamaan itseään, että jokin alue tarvitsee korjauksia ("KORJAA ME").

Tietenkin kirjoitetun selitys on siunaus. Mutta kommenttien avulla voit yliviivata koodin kaikki hyvät puolet. Tämän estämiseksi on tarpeen tehdä ero erilaisten kommenttien välillä:

dokumentointi. Hyvä assosiaatio olisi dokumentoinnin käsite erilaisille ohjelmisto. Tällaiset kommentit, kuten ohjeet, auttavat koodin käytössä. Sellaista kommentointia ei pidetä tarpeettomana, koska ilman sitä ei ole mitään keinoa. Kuvittele, että joku käytti patentoitua kehystä eikä kerro sinulle, kuinka ohjelmaa käytetään;

JavaScript. Nopea aloitus

selittävä. Hyvä koodi ei yleensä niitä tarvitse. Mitä enemmän kommentteja näet ohjelmassa, sitä todennäköisemmin ohjelma on kirjoitettu huonosti. Tämä ei tietenkään ole ehdoton sääntö.

Selittävät kommentit voivat olla hyödyllisiä niille, jotka korjaavat koodia tulevaisuudessa. Esimerkiksi monet nuoret ammattilaiset näkevät parantamisen varaa kaikkialla. He uskovat, että kaikki oli huonompaa ennen heitä, ja nyt on aika korjata jokainen ominaisuus.

Joskus samanlainen tunne voittaa myös ammattilaiset. Esimerkiksi kun kaikki näyttää yllättävän vinolta, täytyy olla parempi ratkaisu. Suojatakseen seuraajia etsimästä jotain parempaa ohjelmoija voi jättää seuraavan huomautuksen: #time_spent_here=24h

Tällaisten sanojen jälkeen harvat ihmiset haluavat viettää niin paljon aikaa. Näin ollen varoitat, että monet erilaisia ​​vaihtoehtoja Jo selvitetty. Samalla sinun tulee välttää tällaisia ​​hyökkäyksiä: #i_hate_this, #try_to_do_better_ass%%le. Tällä tavalla osoitat vain epäammattimaista asennetta. Et saa vaarantaa itseäsi ja työnantajaasi.

Mutta koodikommentoinnin dokumentoinnista voi tulla myös ohjelmoijan painolastia. Yleensä nämä ovat massiivisia alueita, jotka häiritsevät suoraan ohjelmointia. Mutta koodin näyttämiseksi ilman kommentteja tärkeimmillä IDE:illä on vastaava toiminto. PhpStormin ei pitäisi olla poikkeus, mutta valitettavasti. Etsi ominaisuus päivitysdokumenteista.

Merkitse toiminnalliseksi elementiksi

Vaikka kommentoinnin tarkoituksena oli selventää ja auttaa tiimin kehittämisessä, näitä ominaisuuksia ei käytetä niin usein. Tunnisteet sijoitetaan pääsääntöisesti sinne, missä ne haluavat pysäyttää koodin suorittamisen. Oletetaan, että sinulla on PHP upotettuna HTML:ään. Etkä halua poistaa sitä, vaan haluat vain nähdä, miltä sivu näyttää ilman sitä. Tätä varten sinun on noudatettava seuraavaa syntaksia:

JavaScript

…

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

Kuten näet, yksinkertaisilla toimilla voit pysäyttää koodin suorittamisen ilman, että edes suoritat mitään monimutkaisia ​​​​toimintoja. Mutta itse asiassa tämä ei ole optimoinnin huippu. Itse phpStorm IDE tarjoaa kehittäjälle lisämukavuutta. Korostuksilla ja pikanäppäimillä voit kommentoida valittua koodisegmenttiä ilman erityisiä tunnisteita. Tämä voidaan tehdä näin.

Valitse tekstinpätkä (hiiri, pikakuvakkeet) sinulle sopivalla menetelmällä.

Paina näppäinyhdistelmää Ctr + Vaihto + /

Lisäksi voit kommentoida nykyistä riviä. Kaikki on sama, vain ilman Shiftiä.

Tämäntyyppisen kommentoinnin etuna on useiden kielten samanaikainen kattavuus. PHP on harvoin yksinään. Tällä tavalla sinun ei tarvitse turvautua jokaisen merkitsemiseen. Ympäristö tukee useita muita verkkokieliä. Valitse vain fragmentti ja myy yhdistelmä - tämä on monikielinen koodi ja kommentoi. Samalla tavalla se voidaan aktivoida.

Siinä kaikki meille. Jos et ole käyttänyt näitä ominaisuuksia aiemmin, suosittelemme aloittamaan. Pikanäppäimet nopeuttavat ja nopeuttavat työtä.

JavaScript. Nopea aloitus

Opi JavaScriptin perusteet käytännön esimerkin avulla verkkosovelluksen luomisesta

... tänään tässä lyhyessä mutta hyödyllisessä artikkelissa selvitämme kuinka eri ohjelmakoodeja kommentoida. En kerro paljon, koska jos olet kiinnostunut tästä, olet jo kohdannut tämän ongelman ongelmat ja sinulla on siitä käsitys.

Olet tullut oikeaan paikkaan... mutta muutama sana asian selkeyden ja hyödyn vuoksi. Olet luultavasti nähnyt, kuinka tämä tehdään CSS-koodilla, koska CSS kiinnostaa eniten monia aloittelijoita, kuten minä.

… Hieno!

Huomaa kuitenkin, että myös kommentteja käytetään html ja php... Mutta useimmat aloittelijat hämmentyvät työnsä alkuvaiheessa sivuston kanssa eivätkä osaa lisätä tarvittavia selityksiä itselleen. Loppujen lopuksi tapahtuu, että sinun on esimerkiksi poistettava käytöstä joksikin aikaa html-koodi, ja jatka sitten toimintaansa uudelleen - tämä on helppo toteuttaa, jos olet tehnyt muistiinpanoja "marginaaliin", mutta et koskaan tiedä.

Mutta mitä sinun tulee muistaa "kommenteista" yleensä, on se, että kaikki riippuu tiukasti siitä, minkä tiedoston kanssa työskentelet, ja siksi sovelluskoodi on erilainen.

Kommentoi CSS-koodia

a:hover, a:focus ( väri: #D5071E; tekstin koristelu: yliviivaus; /*ALALINE YLÄ*/ )

Näin annat itsellesi selityksen. Tai voit jopa kommentoida tätä css-skriptiä seuraavasti: vain kääri

/* KOODI tähän */

/*a:hover, a:focus (väri: #D5071E; tekstin koristelu: alleviivaus; /*ALAlleviivaus*/)*/

Kiinnitän huomiosi siihen, että voit kommentoida koko css-koodisykliä tällä tavalla, mutta!! sitten joudut poistamaan toistuvat kommentit /*ALAVOIMAA ALALLA*/ tai leikkiä vinoviivalla, jos selitys on tärkeä))

Muuten tulee virhe!!

Huomautus:

Jos avaat sivun lähdekoodin - Ctrl+U ja katsot... näet, että kommentoitu css-koodin pala näkyy täydellisesti luodussa dokumentissa! tämä on jos css:ää käytettiin (ominaisuudet asetettiin) suoraan html:ssä

Ja kuten ymmärrät, jos siirryt lähdekoodista linkin kautta aktiivisen mallisi css-dokumenttiin, kaikki kommentit voidaan tarkkailla ja tutkia)) jos joku tarvitsee sitä. Mutta tämä on epätodennäköistä)

Englannin adverbi (sanat) on luettavissa. Venäjän symbolit - ei.

Kommentoi HTML-koodia

XML-tiedostoa kommentoidaan samalla tavalla

Tärkeää: tarkista aina artikkeleissa tarjottu koodi, ainakin visuaalisesti) muuten saattaa tulla virheitä.

Yksinkertainen huolimattomuus muotoilussa voi maksaa aikaa, esimerkiksi yllä oleva kommentoitu koodi on usein väärä: Kahden lyhyen yhdysviivan sijasta näkyy pitkä viiva:

Tiedoksesi:

kuten edellisessä huomautuksessa mainittiin, sama pätee kommentoituun... html-koodi näkyy luodussa dokumentissa!

Pidä tämä mielessä.

Ja tässä toinen asia:

Sen lisäksi, että kommentoitu koodi näkyy sivun lähdekoodissa (ja siksi sitä käsitellään jossain mielessä, vaikka se on näkymätön sivulla!) - on parempi poistaa jotkin PHP-toiminnot yhdessä html:n kanssa. aktiivisesta asiakirjasta.

Esimerkiksi:

näkyy asiakirjassa ja toiminnossatekee työnsä upeasti: eli tiedot eivät enää näy käyttöliittymässä, mutta lähdekoodissa ne näkyvät selvästi! ja tämä on turha kysely tietokantaan: kaikki tämä on pikku juttu, mutta sinun on tiedettävä!

Tämä on mahdollista, jos et halua poistaa koodinpätkää asiakirjasta:

lisää ennen tarvittavaa "ylimääräistä" html-koodia avaus... sisäänrakennettu toiminto ... ja sulkeminen?> ...

Lyhyesti sanottuna voit tehdä tämän, jos koodi on suuri:

**/ ?>

niin lähde on puhdas!

Tai yksinkertaisempi:

Kommentoidaan itse funktiota html-dokumentissa. Lähdekoodi näissä toimintojen kehittämistä koskevissa tapauksissa on puhdasta!

kuinka kommentoida javascriptiä

if (beingShown || näytetään) ( // älä laukaise animaatiota uudelleen return; ) else ( // käytä riville MITÄÄN KOMMENTTIA // käytä MITÄÄN KOMMENTTIA riville // true;

Selvyyden vuoksi nappasin tämän esimerkin JavaScript-koodin Internetistä ja korjasin hieman välimerkkejä. Sillä ei ole väliä... Tärkeintä on ymmärtää periaate...

Kuten ymmärrät, kaksoisviiva "//" on kommenttimerkki... YKSI RIVI!

Loput JS-koodista on kommentoitu kuten php, lisää siitä alla:

huomautus:

Kommentoi PHP-koodia

...ja...se on samanlainen täällä – kauttaviiva-vinoviiva...yksirivinen.

Mutta huomaa, että sitä voidaan kommentoida aivan kuten CSS-koodia.

...tai voit kommentoida sitä näin - yksirivinen versio, kun käytämme EI KAHTA kauttaviivaa, vaan BECAR (hash) ennen kommentoitavaa riviä:

...Luonnollisesti sinun on kommentoitava huolellisesti koodisilmukassa!

...tai tällä tavalla - kuten yllä olevassa CSS-esimerkissä... eli. tämä /*-koodi */-kommentointivaihtoehto sopii sekä CSS- että JS-koodeille!

Mutta tällä tavalla voit kommentoida laajempaa PHP-koodin selitystä, jossain sen tärkeimpien esimerkkien välissä...

Voit myös kommentoida PHP-silmukoissa tällä tavalla, jos koodi on sekoitettu... php ja jotenkin html

Sama kuin yllä kuvattu:

Esimerkiksi jokin tällainen funktio... jossain yleisessä koodissa (tai silmukassa html:ssä):- voit kommentoida sitä, eli lisätä oman etiketin näin:

tai näin: yksirivinen vaihtoehto...

Älykkyys:

php-koodi ei näy missään lähdekoodissa!! Vain sen toiminnallinen tulos näkyy - treenaa!

Siinä kaikki, mitä halusin tänään raportoida!

Nyt voit kokeilla... Onnea.

Ja tietysti lue sivuston artikkelit ja tilaa:
Jaan katkeran kokemukseni - jonkin verran tietoa suloisen hyvinvoinnin vuoksi))

...verkkomestarien kaupunki Mihalika.ru© - helposti WordPressillä

PHP:n kommentit ovat samanlaisia ​​kuin HTML:ssä käytetyt kommentit. PHP-syntaksissa kommentit alkavat aina erityisellä merkkijonolla ja tulkki ohittaa kaiken näiden erikoismerkkien välissä olevan tekstin.

HTML:ssä kommentin päätarkoitus on toimia huomautuksena kehittäjille, jotka voivat tarkastella sivustosi lähdekoodia. PHP-kommentit eroavat toisistaan ​​siinä, että niitä ei näytetä vierailijoille. Ainoa tapa tarkastella PHP-kommentteja on avata tiedosto muokkausta varten. Tämä tekee PHP-kommenteista hyödyllisiä vain PHP-ohjelmoijille.

Jos unohdit tai et tiennyt, kuinka kommentit tehdään HTML:ssä, katso alla oleva esimerkki.

PHP-kommenttien syntaksi: yksirivinen kommentti

Vaikka html:ssä on vain yksi kommenttityyppi, PHP:ssä on kaksi tyyppiä. Ensimmäinen tyyppi, josta keskustelemme, on yksirivinen kommentti. Eli kommentti, joka käskee tulkkia jättämään huomioimatta kaiken, mitä tapahtuu tällä kommenttien oikealla puolella olevalla rivillä. Käytä tätä kommenttia käyttämällä merkkejä "//" tai "#", jolloin PHP-tulkki ohittaa kaiken oikealla olevan tekstin.

Psst...Et näe PHP-kommenttejani!"; // echo "ei mitään"; // echo "Nimeni on Humperdinkle!"; # echo "en minäkään tee mitään"; ?>

Tulos:

Hei maailma! Psst...Et näe PHP-kommenttejani!

Huomaa, että useita kaikukomentojamme ei käsitelty, koska kommentoimme niitä erityisillä kommenttimerkeillä. Tämän tyyppisiä kommentteja käytetään usein monimutkaisen ja hämmentävän koodin nopeaan kirjoittamiseen tai PHP-koodirivin väliaikaiseen poistamiseen (virheenkorjausta varten).

PHP-kommenttien syntaksi: monirivinen kommentti

Kuten HTML-kommentteja, monirivisiä kommentteja PHP:ssä voidaan käyttää kommentoimaan suuria koodilohkoja tai kirjoittamaan kommentteja useille riveille. Moniriviset kommentit PHP:ssä alkavat kirjaimella "/*" ja päättyvät "*/". Kaikki näiden merkkien välillä jätetään huomioimatta.

Tulos.

Tällä oppitunnilla puhun valmistamisesta kommentit HTML-, CSS-, PHP-kielillä. Kommentit ovat tekstiä, joka ei näy verkkosivulla. Niitä käytetään erilaisiin selityksiin, muistutuksiin ja kuvauksiin verkkovastaaville, mikä mahdollistaa asiakirjan rakenteen. Kommentit ovat välttämättömiä koodin virheenkorjauksessa. Niiden avulla voit nopeasti navigoida verkkosivun merkinnöissä ja löytää haluamasi lohkon. Kommentteja käytetään usein HTML-koodin virheenkorjaukseen. Voit esimerkiksi kommentoida väliaikaisesti tiettyä koodilohkoa, jotta se ei suoriteta, ja tarvittaessa voit helposti palauttaa sen.

Kommentit HTML:ssä

HTML:ssä kommentit muodostetaan käyttämällä seuraavia merkkejä:. Näin ollen mikä tahansa teksti näiden merkkien välillä on kommentti. Katsotaanpa esimerkkiä:

Esimerkki kommenteista HTML:ssä

Kommentit CSS:ssä

CSS:n kommentit luodaan käyttämällä merkkejä: /* ja */. Kommentin luomiseksi sinun tarvitsee vain sijoittaa verkkosivun koodi näiden merkkien väliin:

/* Body-tyyleillä varustetun lohkon alku*/ body ( tausta: #efeded; font-family: Verdana, Helvetica, sans-serif; fontin koko: 12px; marginaali: 0px; täyte: 0px; ) /* Loppu lohko, jossa on tyylejä Bodylle*/

Kommentit PHP:llä

PHP:n kommentit voivat olla yksirivisiä tai monirivisiä:

1) Yksiriviset kommentit PHP:ssä luodaan käyttämällä merkkejä: //. Laita tämä merkki rivin eteen ja se kommentoidaan. Tätä vaihtoehtoa käytetään, kun kommentti koostuu vain yhdestä rivistä.

2) Monirivisten kommenttien toteuttamiseen käytetään seuraavia symboleja: /* ja */. Tämä vaihtoehto on hyödyllinen, jos kommentti kattaa useita rivejä.

Joten opimme tekemään