25.04.2017

Ahojte všetci!
Pokračujte v učení základov PHP od začiatku!
V tomto návode vám poviem, čo je komentár v PHP a v praxi sa pokúsime napísať náš komentár do kódu. To však nie je všetko. Chcem vám tiež povedať, ako komentovať kód a prečo to vôbec musíte urobiť.

V čom je komentárPHP
Komentujte vPHP- toto je pomôcka php vývojára pre rýchlu navigáciu v kóde, ako aj pre úpravy.

Komentár v PHP nie je viditeľný pre používateľa, ktorý otvoril webovú stránku na prezeranie. Aj keď sa používateľ rozhodne pozrieť si zdrojový kód stránky, komentár stále nebude viditeľný, pretože všetky php.

Komentár PHP kódu

Existujú 2 druhy komentárov pre kód PHP:

→ jeden riadok
→ viacriadkový

⇒ Jednoriadkový komentár pre PHP
Pre jednoriadkový komentár použite symboly "//" alebo "#"

Po týchto znakoch bude všetko napísané na jednom riadku ignorované a považované za komentár.

Prihlásiť sa na odber aktualizácie "; # odber (toto je komentár)?>

Prihláste sa na odber aktualizácie

⇒ Viacriadkový komentár pre PHP
Viacriadkový komentár pre PHP začína znakom "/ *" a končí znakom "* /".
Čokoľvek medzi týmito znakmi bude ignorované a bude sa s tým zaobchádzať ako s komentárom.
Ak je v zázname viac riadkov, použije sa viacriadkový komentár.

Na obrazovke uvidíte iba nasledujúci text:

Ahojte čitatelia blogu - stránka!!!

P.S.: Vždy komentujte svoj kód. Ak si myslíte, že všetko, čo ste v kóde urobili, si zapamätáte o 1-2 roky, ste na omyle, šanca je veľmi malá. Aj keď si pamätáte, budete musieť stráviť veľa času štúdiom toho, čo, kde a prečo ...
Urobte pre seba v budúcnosti niečo príjemné - okomentujte kód a potom si poviete „ĎAKUJEM!!!“.
Zanechajte komentár v kóde, zaberie to 1 minútu, ale ušetrí vám to celý deň v budúcnosti.

Komentujte PHP kód

Povedzme, že ste napísali php kód, ale z nejakého dôvodu musíte z kódu odstrániť 2 riadky.
Neponáhľam sa s odstránením niečoho z kódu, najmä ak ide o kód php, radšej by som to okomentoval. Čo ak potrebujete vrátiť kód. Je jednoduchšie odkomentovať, ako napísať kód novým spôsobom.

Ako zakomentovať kódPHP
Príklad s jednoriadkovým komentárom:

Prihláste sa na odber aktualizácie ";?>

Príklad s viacriadkovým komentárom.

Od autora: komentovanie je jednou z tých funkcií, ktoré sa ľahko implementujú. Zároveň môžu byť tieto editačné prvky veľkým prínosom pre vývojárov, ktorí si svoj kód odovzdávajú z ruky do ruky. Dnes sa naučíte, ako komentovať blok v PhpStorm. Zvážime aj zvyšok funkcionality vývojového prostredia na komentovanie obsahu programu.

Komentáre: dobré a zlé

Komentovanie kódu je dostupné vo väčšine programovacích jazykov (možno vo všetkých, ale s rôznou mierou dostupnosti). Verbálne vysvetlenia sa zvyčajne používajú na to, aby pomohli ostatným členom tímu v ďalšom rozvoji, alebo si jednoducho pripomenuli, že táto oblasť potrebuje opravy („FIX ME“).

Samozrejme, vysvetlenie toho, čo je napísané, je požehnaním. Ale pomocou komentárov môžete preškrtnúť aj všetky dobré stránky kódu. Aby sa tomu zabránilo, je potrebné rozlišovať medzi typmi komentárov:

dokumentovanie. Dobrým spojením by bol koncept dokumentácie pre rôzny softvér. Takéto komentáre vám pomôžu použiť kód ako pokyn. Takéto komentovanie nie je vnímané ako zbytočné, pretože bez neho nie je nič. Predstavte si, že niekto použil rámec na tvorbu obsahu a nepovie vám, ako program používať;

JavaScript. Rýchly štart

vysvetľovanie. Dobrý kód ich zvyčajne nepotrebuje. Čím viac riadkov komentárov v programe vidíte, tým je pravdepodobnejšie, že je program zle napísaný. Samozrejme, nie je to absolútne pravidlo.

Vysvetľujúce komentáre môžu byť užitočné pre tých, ktorí v budúcnosti opravia kód. Napríklad veľa mladých odborníkov všade vidí pole na zlepšenie. Veria, že pred nimi to bolo horšie a teraz je čas opraviť každú jednu vlastnosť.

Niekedy podobný pocit premôže aj profesionálov. Napríklad, keď všetko vyzerá prekvapivo krivo, musí existovať lepšie riešenie. Ak chcete zabrániť sledovateľom, aby hľadali to najlepšie, programátor môže zanechať poznámku takto: # time_spent_here = 24h

Po takýchto slovách sa málokomu chce venovať toľko času. Preto varujete, že veľa rôznych možností už bolo vyriešených. Zároveň by ste sa mali vyhnúť takýmto útokom: #i_hate_this, # try_to_do_better_ass %% le. Týmto spôsobom len prejavujete neprofesionálny prístup. Nekompromitujte seba a svojho zamestnávateľa.

Ale dokumentárne komentovanie kódu sa môže stať balastom pre programátora. Spravidla ide o masívne sekcie, ktoré odvádzajú pozornosť priamo od programovania. Aby sa však kód zobrazil bez komentárov, hlavné IDE majú zodpovedajúcu funkciu. PhpStorm by nemal byť výnimkou, ale bohužiaľ. Vyhľadajte funkciu v aktualizačných dokumentoch.

Tag ako funkčný prvok

Zatiaľ čo komentovanie má byť vysvetlením a pomôckou pri rozvoji tímu, tieto funkcie sa bežne nepoužívajú. Značky sa spravidla umiestňujú tam, kde chcú zastaviť vykonávanie kódu. Povedzme, že máte PHP vložené do HTML. A vy to nechcete vymazať, chcete len vidieť, ako stránka vyzerá bez toho. Ak to chcete urobiť, musíte postupovať podľa nasledujúcej syntaxe:

JavaScript

…

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

Ako vidíte, pomocou jednoduchých akcií môžete zastaviť vykonávanie kódu bez toho, aby ste vykonali akékoľvek zložité operácie. Ale v skutočnosti to ešte nie je vrchol optimalizácie. Ďalšie pohodlie pre vývojárov poskytuje samotné phpStorm IDE. Pomocou zvýrazňovania a klávesových skratiek môžete komentovať vybraný segment kódu bez pripájania špecializovaných značiek. Dá sa to urobiť nasledovne.

Pomocou pre vás vhodnej metódy vyberte fragment textu (myš, skratky).

Stlačte klávesovú skratku Ctr + Shift + /

Okrem toho môžete komentovať aktuálny riadok. Všetko je po starom, len bez Shiftu.

Výhodou tohto typu komentovania je súčasné pokrytie viacerých jazykov. PHP je málokedy samo o sebe. Týmto spôsobom sa nemusíte uchýliť k označovaniu každého z nich. Prostredie podporuje niekoľko ďalších webových jazykov. Stačí vybrať fragment a predať kombináciu - toto je viacjazyčný kód a zakomentovaný. Rovnakým spôsobom ho možno aktivovať.

To je z našej strany všetko. Ak ste tieto funkcie ešte nepoužívali, odporúčame vám začať. Skratky urýchľujú a zlepšujú prácu.

JavaScript. Rýchly štart

Naučte sa základy JavaScriptu pomocou praktického príkladu vytvárania webovej aplikácie

Komentáre v PHP sú podobné komentárom používaným v HTML. V syntaxi PHP komentáre vždy začínajú špeciálnou sekvenciou znakov a všetok text, ktorý sa objaví medzi týmito špeciálnymi znakmi, bude interpret ignorovať.

V HTML je hlavným účelom komentára slúžiť ako poznámka pre vývojárov, ktorí môžu zobraziť zdrojový kód vašej stránky. Komentáre PHP sa líšia tým, že sa návštevníkom nezobrazia. Jediný spôsob, ako zobraziť komentáre PHP, je otvoriť súbor na úpravu. Vďaka tomu sú komentáre PHP užitočné iba pre programátorov PHP.

V prípade, že ste zabudli alebo ste nevedeli, ako sa vytvárajú komentáre v HTML, pozrite si príklad nižšie.

Syntax komentára PHP: jednoriadkový komentár

Zatiaľ čo html má iba jeden druh komentárov, PHP má dva. Prvým typom, o ktorom budeme diskutovať, je jednoriadkový komentár. Teda komentár, ktorý tlmočníkovi povie, aby ignoroval všetko, čo sa deje na tomto riadku napravo od komentárov. Ak chcete použiť tento komentár, použite znaky "//" alebo "#" a všetok text napravo bude PHP interpret ignorovať.

Psst ... Nemôžete "vidieť moje komentáre PHP!"; // echo "nič"; // echo "Volám sa Humperdinkle!"; # echo "Nerobím" ani nič ";?>

výsledok:

Ahoj svet! Psst ... Nevidíte moje komentáre PHP!

Všimnite si, že niekoľko našich príkazov echo nebolo spracovaných, pretože sme ich okomentovali špeciálnymi znakmi komentára. Tento typ komentára sa často používa na rýchle napísanie zložitého a mätúceho kódu alebo na dočasné odstránenie riadku kódu PHP (na ladenie).

Syntax komentára PHP: viacriadkový komentár

Podobne ako HTML komentáre, aj PHP viacriadkové komentáre možno použiť na komentovanie veľkých blokov kódu alebo na písanie komentárov cez viacero riadkov. Viacriadkové komentáre v PHP začínajú "/ *" a končia "* /". Čokoľvek medzi týmito znakmi bude ignorované.

Výsledok.

... dnes v tomto krátkom, ale užitočnom článku prídeme na to, ako sa komentuje odlišný programový kód. Nebudem veľa hovoriť, pretože ak vás to zaujíma, už ste sa stretli s otázkami tohto problému a máte o tom predstavu.

Prišli ste na adresu ... ale pár slov pre jasnosť a prospech prípadu. Pravdepodobne ste videli, ako sa to robí s kódom CSS, pretože css najviac zaujíma mnohých začiatočníkov, ako som ja.

… Dobre!

Upozorňujeme však, že komentáre sa používajú aj v html a php... Ale väčšina začiatočníkov je zmätená v počiatočnej fáze svojej práce s webom a nevie, ako si pre seba pridať potrebné vysvetlenia. Koniec koncov, stane sa to tak, že napríklad musíte na nejaký čas deaktivovať html kód, a potom znova obnoviť jeho funkciu - je ľahké ho implementovať, ak ste si urobili poznámky pre seba na "okrajoch", ale nikdy neviete čo.

Čo by sa však malo pamätať na „komentáre“ vo všeobecnosti - tu je všetko prísne závislé od toho, s ktorým súborom konkrétne pracujete, a preto je kód aplikácie odlišný.

Komentovanie kódu CSS

a: vznášanie sa, a: zameranie (farba: # D5071E; dekorácia textu: Overline; / * PODČIARKNUTIE * /)

Takto si vysvetľuješ sám seba. Alebo môžete tento skript css dokonca komentovať takto: jednoducho zabaliť

/ * tu KÓD * /

/ * a: podržte kurzor myši, a: zameranie (farba: # D5071E; dekorácia textu: podčiarknutie; / * PODČIARKNUTIE * /) * /

Upozorňujem na skutočnosť, že - takto môžete komentovať celý cyklus css kódu, ale !! potom musíte odstrániť opakované komentáre / * PODČIARKNÚŤ DONO * /, alebo sa pohrať s lomkami, ak je vysvetlenie dôležité))

V opačnom prípade dôjde k chybe!!

Poznámka:

Ak otvoríte zdrojový kód stránky - Ctrl + U a pozriete sa ... uvidíme, že zakomentovaný kúsok css kódu sa krásne zobrazí vo vygenerovanom dokumente! to je, ak bol css použitý (vlastnosti boli nastavené) priamo v html

A ako viete, ak prejdete zo zdrojového kódu odkazom na css dokument vašej aktívnej šablóny, všetky komentáre možno pozorovať a študovať)), ak to niekto potrebuje. Ale to je nepravdepodobné)

Anglické príslovky (slová) budú čitateľné. Ruská symbolika - č.

Komentovanie HTML kódu

Súbor XML je komentovaný rovnakým spôsobom.

Dôležité: vždy skontrolujte kód uvedený v článkoch, aspoň vizuálne), inak sa môžu vyskytnúť chyby.

Obvyklá neopatrnosť pri formátovaní môže byť časovo náročná, napríklad kód KOMENTOVANÝ vyššie je často chybný: namiesto dvoch krátkych pomlčiek sa zobrazí em pomlčka:

Pre tvoju informáciu:

ako bolo povedané v predchádzajúcej poznámke - taký je komentár ... vo vygenerovanom dokumente sa zobrazí html kód!

Majte to na pamäti.

A tu je ďalšia vec:

okrem toho, že komentovaný kód je zobrazený v zdrojovom kóde stránky (čo znamená, že je v istom zmysle spracovaný, aj keď na stránke bude neviditeľný!) - je lepšie odstrániť niektoré php funkcie v spojení s html z aktívneho dokumentu.

Napríklad:

budú viditeľné v dokumente a vo funkciibude to fungovať úžasne: to znamená, že informácie neuvidíte vo frontende, ale v zdroji - budú jasne zobrazené! a to je bespontovy dotaz do databazy: toto vsetko je malickost, ale treba to vediet!

Je to možné, ak nechcete z dokumentu vyberať časť kódu:

pridajte pred potrebný „extra“ html kód otvorenie... inline funkcia ... a zatváranie?> ...

Jedným slovom, takto to môžete urobiť, ak je kód veľký:

**/ ?>

potom bude zdroj čistý!

Alebo jednoduchšie:

Vyjadrime sa k samotnej funkcii v html dokumente. Zdrojový kód v týchto prípadoch bude čistý s ohľadom na vývoj funkcií!

ako komentovať JavaScript

if (beingShown || zobrazený) (// nespustí animáciu znova return;) else (// v riadku použije ANY COMMENT // v riadku použije ANY COMMENT // true;

Kvôli prehľadnosti som schmatol tento príklad kódu JavaScript v sieti a mierne som upravil interpunkciu. Nevadí... Hlavná vec je pochopiť princíp...

Ako ste pochopili, lomka "//" je dvojitá, toto je ZNAMKO komentára ... JEDEN RIADOK!

Zvyšok kódu JS je komentovaný ako php, viac o tom nižšie:

poznámka:

Komentovanie kódu PHP

... a ... tu je to to isté - lomka-lomka ... jednoriadková.

Všimnite si však, že môže byť anotovaný rovnako ako kód CSS.

... alebo tak môžete komentovať - ​​možnosť s jedným riadkom, keď pred komentovaným riadkom použijeme NIE DVE lomítka, ale BECAR (hash):

... Prirodzene, musíte opatrne komentovať v kódovej slučke!

... alebo rovnakým spôsobom - podobne ako vyššie uvedený príklad pre CSS ... t.j. táto / * kód * / možnosť komentovania bude fungovať pre kódy CSS aj JS!

Ale týmto spôsobom môžete komentovať rozsiahlejšie vysvetlenie kódu PHP, niekde medzi jeho hlavnými príkladmi ...

Môžete tiež komentovať v php slučkách takto, ak je kód zmiešaný ... php a nejako html

Podobne ako vyššie:

Napríklad nejaký druh funkcie ... niekde vo všeobecnom kóde (alebo slučka v html):- môžete komentovať, to znamená pridať svoj vlastný štítok takto:

alebo takto: jednoriadková možnosť...

inteligencia:

php kód nie je viditeľný v žiadnom zdrojovom kóde!! vidno len jeho funkčný výsledok - odpracovanie!

Vo všeobecnosti, to je všetko, čo som dnes chcel nahlásiť!

Teraz môžete experimentovať... Veľa šťastia.

A samozrejme si prečítajte články na stránke a prihláste sa na odber:
Zdieľam svoju trpkú skúsenosť - nejaké vedomosti, pre vašu sladkú pohodu))

... mesto webmasterov Mikhalika.ru© - Jednoducho s WordPress