Od autora: komentovanie je jednou z funkcií, ktoré je možné ľahko implementovať. Tieto editačné prvky môžu byť zároveň veľkým prínosom pre vývojárov, ktorí si odovzdávajú kód z ruky do ruky. Dnes sa naučíte, ako komentovať bloky v PhpStorm. Zohľadníme aj zvyšok funkcií vývojového prostredia na komentovanie obsahu programu.

Komentáre: dobré a zlé

Komentovanie kódu je k dispozícii vo väčšine programovacích jazykov (pravdepodobne všetky, ale s rôznym stupňom dostupnosti). Slovné vysvetlenia sa zvyčajne používajú na pomoc ďalším členom tímu v ďalšom rozvoji alebo jednoducho na pripomenutie, že táto oblasť potrebuje opravy („OPRAVIŤ MI“).

Vysvetlenie toho, čo je napísané, je samozrejme požehnaním. Pomocou komentárov však môžete tiež prečiarknuť všetky dobré aspekty kódu. Aby sa tomu zabránilo, je potrebné rozlišovať medzi typmi komentárov:

dokumentovanie. Dobrou asociáciou by bol koncept dokumentácie pre rôzne softvér... Takéto komentáre vám pomôžu použiť kód ako inštrukciu. Takéto komentovanie nie je vnímané ako nadbytočné, pretože bez neho neexistuje nič. Predstavte si, že niekto použil autorský rámec a nehovorí vám, ako program používať;

JavaScript. Rýchly štart

vysvetľujúce. Dobrý kód ich spravidla nepotrebuje. Čím viac riadkov komentárov uvidíte v programe, tým je väčšia pravdepodobnosť, že program je 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. Mnoho mladých profesionálov napríklad vidí všade priestor na zlepšenie. Veria, že veci boli pred nimi horšie, a teraz je načase napraviť každú jednu funkciu.

Niekedy podobný pocit prevalcuje profesionálov. Keď napríklad všetko vyzerá prekvapivo krivo, musí existovať lepšie riešenie. Aby programátor nešetril hľadanie najlepších, môže program zanechať nasledujúcu poznámku: # time_spent_here = 24h

Po takýchto slovách chce málokto stráviť toľko času. Preto varujete, že sada rôzne možnosti už prešli. Zároveň by ste sa mali vyhnúť takýmto útokom: #i_hate_this, # try_to_do_better_ass %% le. Týmto spôsobom iba prejavujete neprofesionálny prístup. Nekompromitujte seba a svojho zamestnávateľa.

Dokumentárne komentovanie kódu sa však 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 mohol zobrazovať bez komentárov, hlavné IDE majú zodpovedajúcu funkciu. PhpStorm by nemal byť výnimkou, ale bohužiaľ. Túto funkciu vyhľadajte v aktualizačných dokumentoch.

Označiť ako funkčný prvok

Aj keď má komentovanie slúžiť ako vysvetlenie a pomoc pri rozvoji tímu, tieto funkcie sa nepoužívajú tak často. Značky sú spravidla umiestnené tam, kde chcú zastaviť spustenie kódu. Povedzme, že máte PHP vložené v HTML. A nechcete ho vymazať, chcete len vidieť, ako stránka vyzerá bez nej. Na tento účel musíte dodržať nasledujúcu syntax:

JavaScript

…

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

Ako vidíte, jednoduchými akciami môžete zastaviť vykonávanie kódu bez toho, aby ste museli vykonávať akékoľvek zložité operácie. V skutočnosti to však ešte nie je vrchol optimalizácie. Ďalšie pohodlie pre vývojárov poskytuje samotný phpStorm IDE. Pomocou zvýraznenia a klávesových skratiek môžete komentovať vybraný segment kódu bez toho, aby ste museli pripájať špecializované značky. To je možné vykonať nasledovne.

Vyberte metódu, ktorá vám vyhovuje, a vyberte časť textu (myš, skratky).

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

Okrem toho môžete komentovať aktuálny riadok. Všetko je rovnaké, len bez Shift.

Výhodou tohto typu komentovania je súčasné pokrytie viacerých jazykov. PHP je len zriedka samo osebe. 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 komentovaný. Rovnakým spôsobom sa dá aktivovať.

To je pre nás všetko. Ak ste tieto funkcie ešte nepoužili, odporúčame vám začať. Skratky robia prácu rýchlejšie a lepšie.

JavaScript. Rýchly štart

Naučte sa základy JavaScriptu s praktickým príkladom vytvárania webovej aplikácie

... 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 ňom predstavu.

Prišli ste na adresu ... ale pár slov pre zrozumiteľnosť a prospech prípadu. Pravdepodobne ste videli, ako sa to robí s kódom CSS, pretože css je pre mnoho začiatočníkov, ako som ja, najzaujímavejším.

… Dobre!

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

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

Komentovanie kódu CSS

a: hover, a: focus (farba: # D5071E; dekorácia textu: pretiahnuté; / * PODČIERAŤ HORE * /)

Takto si sám sebe vysvetľuješ. Alebo môžete tento skript css dokonca komentovať úplne takto: jednoducho zabaľte

/ * KÓD tu * /

/ * a: hover, a: focus (farba: # D5071E; dekorácia textu: podčiarknutie; / * PODČASŤ * /) * /

Upozorňujem na skutočnosť, že - týmto spôsobom môžete komentovať celý cyklus kódu CSS, ale !! potom musíte odstrániť opakované komentáre / * PODČIERAŤ SPODNÉ * alebo hrať s lomkami, ak je vysvetlenie dôležité))

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

Poznámka:

Ak otvoríte zdroj stránka - Ctrl + U a pozrite sa ... uvidíme, že komentovaný kus kódu css sa vo vygenerovanom dokumente krásne zobrazí! to je, ak bol css použitý (vlastnosti boli nastavené) priamo v html

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

Anglické príslovie (slová) bude čitateľné. Ruská symbolika - nie.

Komentovanie kódu HTML

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.

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

Pre tvoju informáciu:

ako je uvedené 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ď bude na stránke neviditeľný!) - je lepšie odstrániť niektoré funkcie php súčasne s html z aktívneho dokumentu.

Napríklad:

budú viditeľné v dokumente a vo funkciisvoju úlohu zvládne úžasne: to znamená, že informácie nebudú zobrazené vo frontende, ale v zdroji - budú jasne zobrazené! a to je požiadavka bespontovy do databázy: to všetko je maličkosť, ale musíte to vedieť!

Je to možné, ak nechcete z dokumentu odstrániť kúsok kódu:

pridajte pred potrebný „extra“ html kód otvor... vložená funkcia ... a zatváranie?> ...

Stručne povedané, takto to môžete urobiť, ak je kód veľký:

**/ ?>

potom bude zdroj čistý!

Alebo jednoduchšie:

Poznamenajme si samotnú funkciu v html dokument... Zdrojový kód v týchto prípadoch bude čistý vo vzťahu k vývoju funkcií!

ako komentovať JavaScript

if (beingShown || zobrazené) (// nespúšťa animáciu znova, vráť sa;) else (// na riadok aplikuj KAŽDÝ KOMENTÁR // na riadok použi AKÝKOĽVEK KOMENTÁR // pravda;

Pre prehľadnosť som chytil tento príklad kódu JavaScript do siete a mierne upravil interpunkciu. Nevadí ... Hlavnou vecou je porozumieť princípu ...

Ako chápete, lomka „//“ je dvojnásobná, toto je ZNAK komentára ... JEDNA RIADKA!

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é-lomítko-lomítko ... jednoriadkové.

Všimnite si však, že ho možno komentovať rovnako ako kód CSS.

... alebo to môžete komentovať - ​​jednoriadková možnosť, keď pred komentovaným riadkom použijeme NIE DVA SLASHY, ale BECAR (hash):

... Prirodzene, musíte starostlivo komentovať v slučke kódu!

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

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

Môžete tiež takto komentovať v php slučkách, 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čke v html):- môžete to komentovať, to znamená, pridať svoj vlastný štítok takto:

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

Inteligencia:

php kód nie je viditeľný v žiadnom zdrojovom kóde !! je viditeľný iba jeho funkčný výsledok - funguje to!

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

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

A samozrejme si prečítajte články na webe a prihláste sa na odber:
Podelím sa o svoje trpké skúsenosti - niektoré znalosti pre vašu sladkú pohodu))

... mesto webmasterov Mikhalika.ru© - Ľahko s WordPress

V tejto lekcii budem hovoriť o tom, ako komentáre v HTML, CSS, PHP... Komentáre sú text, ktorý nie je na webovej stránke viditeľný. Používajú sa na všetky druhy vysvetlení, pripomenutí, popisov pre správcov webu, čo vám umožňuje štruktúrovať dokument. Komentáre sú pri ladení kódu nepostrádateľné, umožňujú vám rýchlo sa pohybovať po značkách webovej stránky a nájsť požadovaný blok. Na ladenie HTML kódu sa často používajú komentáre. Môžete napríklad dočasne okomentovať konkrétny blok kódu, aby sa nespustil, a v prípade potreby ho možno ľahko obnoviť.

HTML komentáre

V HTML sú komentáre tvorené symbolmi:... Akýkoľvek text medzi týmito symbolmi je teda komentár. Uvažujme o príklade:

Príklad komentárov HTML

Komentáre v CSS

Komentáre CSS sa vytvárajú pomocou symbolov: / * a * /. Ak chcete vytvoriť komentár, stačí vložiť kód webovej stránky medzi tieto symboly:

/ * Začiatok bloku so štýlmi pre Body * / body (pozadie: #efeded; rodina fontov: Verdana, Helvetica, bezpatkové; veľkosť písma: 12 pixelov; okraj: 0 pixelov; odsadenie: 0 pixelov;) / * Koniec blok so štýlmi pre telo * /

Pripomienky PHP

Komentáre PHP môžu byť jednoriadkové alebo viacriadkové:

1) Jednoriadkové komentáre v PHP sa vytvárajú pomocou symbolov: //. Tento symbol stačí vložiť pred riadok a bude komentovaný. Táto možnosť sa používa v prípade, že komentár pozostáva iba z jedného riadka.

2) Na implementáciu viacriadkových komentárov sa používajú tieto symboly: / * a * /. Táto možnosť je užitočná, ak komentár obsahuje viac riadkov.

Preto sme sa naučili robiť

25.04.2017

Ahojte všetci!
Pokračujeme v štúdiu Základy PHP od nuly!
V tomto návode vám poviem, čo je to komentár v PHP a v praxi sa pokúsime napísať náš komentár do kódu. Ale to nie je všetko. Tiež vám chcem povedať, ako komentovať kód a prečo by sa to malo vôbec robiť.

V čom je komentárPHP
Komentovať vPHP- toto je rada vývojára php na rýchlu navigáciu v kóde, ako aj na úpravy.

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

Komentár kódu PHP

K kódu PHP existujú 2 druhy komentárov:

→ jeden riadok
→ viacriadkový

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

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

Prihlásiť sa na odber aktualizácií "; # predplatné (toto je komentár)?>

Prihláste sa na aktualizáciu

⇒ Viacriadkový komentár pre PHP
Viacriadkový komentár pre PHP začína znakom „ / *“ a končí znakom „ * /“.
Čokoľvek medzi týmito postavami bude ignorované a bude to považované za komentár.
Ak je v zázname viac riadkov, použije sa viacriadkový komentár.

Na obrazovke sa zobrazí iba nasledujúci text:

Ahojte čitatelia blogov - stránka !!!

P.S.: Svoj kód vždy okomentujte. Ak si myslíte, že si za 1-2 roky zapamätáte všetko, čo ste v kóde urobili, 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 ...
Spríjemnite si budúcnosť - okomentujte kód a potom si poviete „ĎAKUJEME !!!“.
Nechajte v kóde komentár, bude to trvať 1 minútu, ale v budúcnosti vám to ušetrí celý deň.

Okomentujte kód PHP

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

Ako okomentovať kód vPHP
Príklad s jednoriadkovým komentárom:

Prihlásiť sa na odber aktualizácie ";?>

Príklad s viacriadkovým komentárom.