Megjegyzések html-ben és php-ben. Megjegyzések HTML, CSS, PHP nyelven

25.04.2017

Helló!
Továbbra is a nulláról tanuljuk a PHP alapjait!
Ebben a leckében elmondom, mi a megjegyzés PHP-ben, és a gyakorlatban megpróbáljuk beleírni a megjegyzésedet a kódba. De ez még nem minden. Azt is szeretném elmondani, hogyan kell kommentálni a kódot, és egyáltalán miért kell ezt megtenni.

Mit tartalmaz a megjegyzésPHP
HozzászólásPHP egy php-fejlesztői tipp a kódban való gyors tájékozódáshoz, valamint a szerkesztéshez.

A PHP-beli megjegyzéseket nem láthatja az a felhasználó, aki megnyitotta a weboldalt megtekintésre. Még ha a felhasználó úgy dönt, hogy megnézi az oldal forráskódját, a megjegyzés továbbra sem lesz látható, mivel az összes php.

PHP kód megjegyzés

A PHP kódhoz kétféle megjegyzés létezik:

→ egysoros
→ többsoros

⇒ Egysoros megjegyzés PHP-hez
Egysoros megjegyzésekhez használja a "//" vagy a "#" karaktereket

E karakterek után az egy sorba írt minden figyelmen kívül marad, és megjegyzésként kezeli.

Feliratkozás a frissítésre"; # feliratkozás (ez egy megjegyzés) ?>

Feliratkozás a frissítéshez

⇒ Többsoros megjegyzés PHP-hez
A PHP többsoros megjegyzése „/*” karakterrel kezdődik és „*/”-re végződik.
A karakterek között lévő bármit figyelmen kívül hagyunk, és megjegyzésként kezeljük.
Többsoros megjegyzést használunk, ha több sor van a bejegyzésben.

A képernyőn csak a következő szöveg jelenik meg:

Sziasztok a blog oldal olvasói!!!

P.S.: Mindig kommentálja a kódot. Ha úgy gondolja, hogy 1-2 év múlva mindenre emlékezni fog, amit a kódban tett, akkor téved, nagyon kicsi az esélye. Még ha emlékszel is, sok időt kell töltenie a tanulással - mit, hol és miért ...
Tedd kellemessé a jövőt magadnak - írd ki a kódot, és azt mondod magadban: "KÖSZÖNÖM!!!".
Hagyjon megjegyzést a kódba, ez 1 percet vesz igénybe az idejéből, de a jövőben egy egész napot megspórolhat.

Írd meg kommentben a PHP kódot

Tegyük fel, hogy írtál egy php kódot, de valamiért el kell távolítani a kódból 2 sort.
Nem sietek valamit kivenni a kódból, főleg ha php kódról van szó, akkor inkább kommentálom. És hirtelen vissza kell adni a kódot. Könnyebb kihagyni a megjegyzéseket, mint új módon írni a kódot.

Hogyan írjunk megjegyzést a kódbaPHP
Példa egysoros megjegyzéssel:

Feliratkozás a frissítésre"; ?>

Példa többsoros megjegyzéssel.

A szerzőtől: A kommentálás az egyik könnyen megvalósítható funkció. Ugyanakkor ezek a szerkesztő elemek nagy hasznot jelenthetnek azoknak a fejlesztőknek, akik kézről kézre adják át a kódot. Ma megtanulod, hogyan írj megjegyzést egy blokkhoz a PhpStormban. A fejlesztői környezet többi funkcióját is figyelembe vesszük a program tartalmának kommentálásához.

Megjegyzések: jó és rossz

A kód kommentálásának lehetősége a legtöbb programozási nyelven elérhető (talán mindegyiken, de változó elérhetőséggel). A szóbeli pontosításokat általában arra használják, hogy segítsék a csapat többi tagját a további fejlődésben, vagy egyszerűen csak emlékeztessenek arra, hogy ezen a területen javításra van szükség („FIX ME”).

Természetesen a leírtak magyarázata áldás. De a megjegyzések segítségével a kód minden jó oldalát áthúzhatja. Ennek elkerülése érdekében különbséget kell tenni a megjegyzések típusai között:

dokumentálása. Jó asszociáció lenne a különféle szoftverek dokumentációjának koncepciója. Az ilyen megjegyzések, mint egy utasítás, segítik a kód használatát. Az ilyen megjegyzéseket nem tartják feleslegesnek, mert e nélkül nincs mód. Képzelje el, hogy valaki használta a szerzői keretrendszert, és nem mondja meg, hogyan kell használni a programot;

JavaScript. Gyors kezdés

magyarázó. A jó kódnak általában nincs szüksége rájuk. Minél több megjegyzéssort lát egy programban, annál valószínűbb, hogy a program rosszul van megírva. Természetesen ez nem abszolút szabály.

A magyarázó megjegyzések hasznosak lehetnek azok számára, akik a jövőben javítani fogják a kódot. Sok fiatal szakember például mindenütt lát javítanivalót. Úgy gondolják, hogy minden rosszabb volt előttük, és most itt az ideje, hogy minden egyes funkciót kijavítsunk.

Néha hasonló érzés keríti hatalmába a szakembereket. Például, amikor minden meglepően ferdének tűnik – biztos van jobb megoldás. Annak érdekében, hogy a követők ne keressenek valami jobbat, egy programozó hagyhat egy ilyen megjegyzést: #time_spent_here=24h

Ilyen szavak után kevesen akarnak ennyi időt tölteni. Így Ön arra figyelmeztet, hogy sok különböző lehetőséget már rendeztek. Ugyanakkor kerülnie kell az ilyen támadásokat: #i_hate_this, #try_to_do_better_ass%%le. Ezzel csak szakszerűtlen hozzáállást tanúsítasz. Ne kompromittálja magát és a munkáltatót.

De a kódkommentálás dokumentálása ballaszttá is válhat a programozó számára. Általában ezek hatalmas részek, amelyek közvetlenül elvonják a figyelmet a programozásról. De a kód megjegyzések nélküli megjelenítéséhez van egy megfelelő funkció a fő IDE-ben. Nem lehet kivétel és a PhpStorm, de sajnos. Keresse a funkciót a frissítési dokumentumokban.

Címke a funkcionalitás elemeként

Míg a kommentálás célja volt a pontosítás és a csapatfejlesztés segítése, ezeket a funkciókat nem használják olyan gyakran. A címkéket általában ott helyezik el, ahol le akarják állítani a kód végrehajtását. Tegyük fel, hogy a PHP be van ágyazva a HTML-be. És nem törölni akarod, csak látni, hogy néz ki az oldal nélküle. Ehhez a következő szintaxist kell követnie:

JavaScript

…

...

…< div > . . . < / div >

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

< div > . . . < / div >

Amint látja, egyszerű műveletekkel leállíthatja a kód végrehajtását anélkül, hogy bármilyen bonyolult műveletet végrehajtana. De valójában ez még nem az optimalizálás csúcsa. A fejlesztő további kényelmét maga a phpStorm IDE biztosítja. A kiemelések és a billentyűparancsok segítségével speciális címkék hozzárendelése nélkül kommentálhatja a kiválasztott kódrészletet. Ezt így is meg lehet csinálni.

Az Ön számára megfelelő módszerrel válasszon ki egy szövegrészt (egér, parancsikonok).

Nyomja meg a Ctr + Shift + / billentyűkombinációt

Ezen kívül hozzászólhat az aktuális sorhoz. Mindegy, csak Shift nélkül.

Az ilyen típusú kommentálás előnye, hogy egyszerre több nyelvet is lefed. A PHP önmagában ritka. Így nem kell mindegyiket megcímkéznie. A környezet több webnyelvet is támogat. Csak válasszon ki egy töredéket, és adja el a kombinációt - ez a többnyelvű kód és megjegyzés. Ugyanígy lehet aktívvá tenni.

Ennyivel rendelkezünk. Ha még nem használta ezeket a funkciókat, javasoljuk, hogy kezdje el. A rövidítések gyorsabbá és jobbá teszik a munkát.

JavaScript. Gyors kezdés

Tanulja meg a JavaScript alapjait a webalkalmazás készítésének gyakorlati példáján keresztül

A PHP megjegyzései hasonlóak a HTML-ben használt megjegyzésekhez. A PHP szintaxisban a megjegyzések mindig egy speciális karaktersorozattal kezdődnek, és a speciális karakterek között megjelenő szövegeket az értelmező figyelmen kívül hagyja.

A HTML-ben a megjegyzések fő célja, hogy megjegyzésként szolgáljanak a fejlesztőknek, akik megtekinthetik webhelye forráskódját. A PHP megjegyzések abban különböznek, hogy nem jelennek meg a látogatók számára. A PHP megjegyzések egyetlen módja a fájl megnyitása szerkesztésre. Emiatt a PHP megjegyzések csak a PHP programozók számára hasznosak.

Ha elfelejtette vagy nem tudta, hogyan készülnek a megjegyzések HTML-ben, nézze meg az alábbi példát.

php megjegyzés szintaxis: egysoros megjegyzés

Míg a html-ben csak egy típusú megjegyzés található, a PHP-ben kétféle. Az első típus, amelyet megvitatunk, az egysoros megjegyzés. Azaz egy megjegyzés, amely arra utasítja a tolmácsot, hogy hagyja figyelmen kívül azt, ami a megjegyzések jobb oldalán található sorban történik. A megjegyzés használatához használja a "//" vagy a "#" karaktereket, és a jobb oldali szöveget figyelmen kívül hagyja a PHP értelmezője.

Psst...Nem látod a PHP megjegyzéseimet! // echo "semmi"; // echo "A nevem Humperdinkle!"; # echo "Én sem csinálok semmit"; ?>

Eredmény:

Helló Világ! Psst...Nem látod a PHP megjegyzéseimet!

Vegye figyelembe, hogy több visszhangparancsunkat nem dolgoztuk fel, mert speciális megjegyzéskarakterekkel kommentáltuk őket. Az ilyen típusú megjegyzéseket gyakran használják összetett és homályos kódok gyors írására, vagy egy PHP-kódsor ideiglenes eltávolítására (hibakeresési célból).

php megjegyzés szintaxis: többsoros megjegyzés

A HTML-megjegyzésekhez hasonlóan a többsoros megjegyzések a PHP-ben is használhatók nagy kódtömbök megjegyzésére, vagy megjegyzések írására több sorba. A PHP többsoros megjegyzései „/*” karakterrel kezdődnek, és „*/”-re végződnek. A karakterek között található minden figyelmen kívül lesz hagyva.

Eredmény.

... ma ebben a rövid, de hasznos cikkben vagyunk, kitaláljuk, hogyan kommentálják a különböző programkódokat. Nem fogok sokat beszélni, mert akit ez érdekel, akkor már találkozott ennek a feladatnak a kérdéseivel, és van róla elképzelése.

Jó helyen járt... de néhány szó az érthetőség és a hasznosság kedvéért. Biztosan láttad, hogyan csinálják ezt a CSS-kóddal, mivel a css sok kezdőt érdekel, mint például én.

… Jó!

De vegye figyelembe, hogy a megjegyzéseket is használják html és php... A legtöbb kezdő azonban összezavarodik az oldallal végzett munkája kezdeti szakaszában, és nem tudja, hogyan adja hozzá a szükséges magyarázatokat. Végül is ugyanúgy megtörténik, például ki kell kapcsolnia egy ideig html kódot, majd ismét folytatja a funkcióját – ez könnyen megvalósítható, ha megjegyzi a „margókat”, de soha nem tudja, mit.

De mit kell emlékezni a „megjegyzésekről” általában - itt minden szigorúan attól függ, hogy melyik fájllal dolgozik konkrétan, ezért az alkalmazás kódja eltérő.

A CSS kód kommentálása

a:hover, a:focus ( szín: #D5071E; szöveg-dekoráció: Overline; /*aláhúzás felül*/ )

Így magyarázod magad. Vagy általában így kommentálhatja ezt a css szkriptet: csak csomagolja

/* KÓD ide */

/*a:hover, a:focus ( szín: #D5071E; szövegdekoráció: aláhúzás; /*ALS ALAKÍTÁS*/ )*/

Felhívom a figyelmet, hogy - a css kód teljes ciklusát így kommentálhatod, de !! akkor el kell távolítania az ismétlődő megjegyzéseket /* ALATT */, vagy játsszon perjelekkel, ha fontos a magyarázat))

Különben hiba lesz!!

Jegyzet:

Ha megnyitja az oldal forráskódját - Ctrl + U, és megnézi ... látni fogjuk, hogy a kommentált css kódrészlet tökéletesen megjelenik a generált dokumentumban! ez akkor van, ha a css-t közvetlenül a html-ben használták (beállították a tulajdonságokat).

És amint érti, ha követi a forráskód linkjét az aktív sablon css dokumentumához, megfigyelheti és tanulmányozhatja az összes megjegyzést)), ha valakinek szüksége van rá. De ez nem valószínű.)

Az angol nyelvjárás (szavak) olvasható lesz. Orosz szimbólumok - nem.

A HTML kód kommentálása

Az XML-fájlt ugyanúgy kommentálják.

Fontos: mindig ellenőrizze a cikkekben javasolt kódot, legalább vizuálisan, különben hibák léphetnek fel.

Az egyszerű formázási gondatlanság időbe kerülhet, például a fent látható MEGJEGYZÉS kód gyakran hibás: két rövid kötőjel helyett egy em kötőjel rajzolódik ki:

Tájékoztatásul:

ahogy az előző megjegyzésben is említettük - így a megjegyzés is... a html kód megjelenik a generált dokumentumban!

Ezt tartsd észben.

És itt van még valami:

amellett, hogy a kommentált kód megjelenik az oldal forráskódjában (és ezért bizonyos értelemben feldolgozásra kerül, bár láthatatlan lesz az oldalon!) - jobb néhány php függvényt eltávolítani a html-mel együtt az aktív dokumentumból.

Például:

látható lesz a dokumentumban és a függvénybenfeltűnően jól teszi majd a dolgát: vagyis a front-endben nem látszanak majd az információk, a forráskódban viszont jól láthatóan! és ez egy bespontovy kérés az adatbázishoz: mindez csekélység, de tudnod kell!

Ezt megteheti, ha nem szeretne kódrészletet kivenni a dokumentumból:

add a szükséges "extra" html kód megnyitása elé… inline funkció… és bezárás?> …

Egyszóval ezt teheti, ha a kód nagy:

**/ ?>

akkor tiszta lesz a forrás!

Vagy egyszerűbben:

Jegyezzük meg magát a függvényt a html dokumentumban. A forráskód ezekben az esetekben a függvények fejlesztését illetően tiszta lesz!

hogyan lehet kommentelni a javascriptet

if (beingShown || displayed) ( // ne indítsa újra az animációt return; ) else ( // BÁRMELY MEGJEGYZÉS alkalmazása a sorban // BÁRMELY MEGJEGYZÉS alkalmazása a sorra // igaz;

Ezt a JavaScript-kód mintát – az egyértelműség kedvéért felkaptam a neten, kicsit javítva az írásjeleket. Nem számít... A lényeg, hogy megértsük az elvet...

Amint érted, a „//” perjel dupla, ez a megjegyzés JELE ... EGYSOROS!

A JS-kód többi részét pedig php-ként kommentálják, erről alább:

jegyzet: