... 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... Ale väčšina začiatočníkov je 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 tento skript css môžete dokonca komentovať takto: jednoducho zabaľte

/ * tu KÓD * /

/ * 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 zdrojový kód stránky - Ctrl + U a pozriete sa ... uvidíme, že komentovaný kúsok 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:

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 || shown) (// nespúšťaj animáciu znova, vráť sa;) else (// na riadok aplikuj KAŽDÝ KOMENTÁR // na riadok použi Ľubovoľný KOMENTÁR // true;

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 ste pochopili, 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, v cykle kódu musíte komentovať opatrne!

... 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 čom som dnes chcel informovať!

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

Michael 2016-05-05 1 HTML a CSS 2

Ako do kódu napísať komentáre html?

Dnes vám poviem, ako komentovať kód v html. Komentáre sú veľmi užitočná vec. Nijako neovplyvňujú spustenie kódu a vzhľad stránok a nie je ich možné vidieť v zdrojovom kóde stránky. V skutočnosti je možné komentáre vidieť iba otvorením súboru v editore. V mojom programe Poznámkový blok ++ sú zvýraznené zelenou farbou.

Ako zanechať komentár v html?

Veľmi ľahké. Syntax pre komentár v značkovacom jazyku je nasledovná:

Môžete teda komentovať nielen jeden riadok, ale aj niekoľko. Hlavná vec, ktorú si treba zapamätať, je to- zatváranie. Vnútri takejto konštrukcie môžete použiť iba vysvetľujúci text a značky v hranatých zátvorkách, prehliadač ich neprečíta.

Ako som už povedal, komentár má nasledujúce vlastnosti:

1. na stránke to nie je vidieť
2. a v zdrojovom kóde tiež nie, ale iba pri úprave súboru
3. všetky značky, ktoré sú v ňom umiestnené, nebudú prehliadačom nijako spracované

Načo to je

Hlavným účelom komentárov je pomôcť iným vývojárom. Pri kódovaní môžete výslovne uviesť, ktorá časť kódu tvorí hlavičku a ktorá časť tvorí hlavnú časť. Skúsení programátori by to samozrejme pochopili aj bez toho, ale čítanie a porozumenie kódu sa zlepšuje. A tiež komentáre pomáhajú ľuďom, ktorí nerozumejú html dobre, koniec koncov, aspoň trochu rozumejú tomu, čo je napísané. Tu je príklad ich použitia:

Druhým možným použitím komentára je urobiť nejaký kus kódu na nejaký čas neaktívnym, keď by ste ho nechceli vymazať, ale jeho spustenie musíte nejako deaktivovať. Mimochodom, môže to pomôcť identifikovať rôzne chyby rozloženia.

Vo všeobecnosti je jednou z dobrých vlastností každého vývojára webu schopnosť písať krásne navrhnutý a zrozumiteľný kód. To znamená, že musíte použiť odsadenie, ktoré ukazuje vnorenie prvkov, v prípade potreby tiež zanechať komentáre, oddeliť hlavné časti dokumentu zalomením riadka atď. To všetko pomáha tým, ktorí budú kód v budúcnosti upravovať, ako aj samotnému autorovi, ktorý sa vo vlastnej tvorbe nestratí.

Začnem tento článok tým, na čo slúžia komentáre. Predpokladajme, že vyvíjate modul so zložitou štruktúrou. Alebo vytvoríte rozloženie s mnohými prílohami prvkov. V takýchto prípadoch je najlepšie niektoré časti kódu nejako označiť - na to existujú komentáre.

Teraz podrobne ukážem štyri typy komentárov, presnejšie všetky ich typy pre štyri rôzne kódy.

Komentáre HTML

Ak chcete pridať komentár k značkám HTML, použite:

Všetko, čo je v týchto značkách, nie je viditeľné na obrazovke, ale je k dispozícii na zobrazenie v zdrojovom kóde.

Komentáre v štýloch CSS

Ak chcete pridať komentár k štýlom CSS, použite:

Všetko, čo je v týchto značkách, sa neberie do úvahy pri vytváraní štýlov, ale je k dispozícii na zobrazenie v samotnom súbore štýlov.

Komentáre JavaScript

Na pridávanie komentárov v JavaScripte existujú ich dva druhy.

Prvý typ:

// Text, kód alebo iné

Druhý typ:

/ * Text, kód alebo iné * /

Všetko, čo je v týchto značkách, sa pri spustení skriptu neberie do úvahy, ale je k dispozícii na zobrazenie v samotnom súbore JavaScript.

Pripomienky v kóde PHP

Tento programovací jazyk, na rozdiel od predchádzajúcich, má 3 typy komentárov.

Prvý typ:

// Text, kód alebo iné

Druhý typ:

/ * Text, kód alebo iné * /

A tretí typ:

# Text, kód alebo iné

Všetko, čo je v týchto značkách, sa pri vykonávaní skriptu neberie do úvahy a je viditeľné iba v samotnom súbore PHP.

Poznámka!

/ * / * Môj kód * / * /

zobrazí sa vám chyba.

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é pomocou symbolov:... 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; výplň: 0 pixelov;) / * Koniec bloku 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ť

Pri práci programátora si musíte neustále robiť poznámky vo forme komentárov, aby ste opísali časť kódu alebo značky pre budúcnosť. Každý jazyk má svoju vlastnú syntax, a preto je pri vývoji webových stránok častým problémom nevedieť, ako komentovať riadok v HTML alebo len malý blok naraz.

HTML komentáre

Pri vývoji webovej stránky je niekedy potrebné na chvíľu skryť časť kódu alebo urobiť poznámku pre programátora. Aby ste nepoužívali ďalšie aplikácie, napríklad prenos časti kódu do iného súboru, musíte vedieť, ako komentovať riadok v HTML.

Na rozdiel od väčšiny programovacích jazykov nemá HTML špeciálnu funkciu ani značku na vytváranie jednoriadkových komentárov. Ak potrebujete „skryť“ iba jeden riadok alebo jeho časť, musíte použiť klasickú jazykovú sadu nástrojov. Existuje však niekoľko spôsobov, ako to urobiť.

Štandardný komentár

Najľahší spôsob, ako komentovať časť kódu v HTML, je použiť špeciálne páry znakov. Pred začatím komentára musíte zadať „". Všetko, čo je v tejto štruktúre, bude teda pred načítaním stránky pred používateľom skryté.

Treba poznamenať, že pri práci s komentárom musíte byť mimoriadne opatrní. Pri definovaní jej hraníc musíte skontrolovať, či do nej nespadla nejaká otváracia alebo zatváracia značka, ktorej druhá časť zostala mimo nej - v tomto prípade bude načítanie stránky nesprávne. V jednom komentári tiež nemôžete vytvoriť niekoľko ďalších - týmto písaním prvý signál na koniec komentujúcej časti otvorí celú nasledujúcu časť skrytého textu.

Nasleduje príklad správneho pravopisu:

Toto je komentár.

Označiť

V HTML môžete tiež komentovať riadky pomocou špeciálnej dvojice značiek - ... Na tento účel je konkrétne zahrnutý v jazykovej syntaxi, ale väčšina populárnych prehliadačov to s výnimkou programu Internet Explorer 8.0 nepodporuje. Označiť Užitočné, keď je potrebné skryť niektoré informácie iba pre IE 8.0, 4.0 a staršie, alebo ako dočasné riešenie počas vývoja. Tu je konkrétne to, že časť kódu môžete komentovať iba v tele stránky, tj. Vo vnútri značky. .

V nižšie uvedenom príklade, keď je stránka načítaná v určených prehliadačoch, zobrazí sa biely list, v iných programoch sa stránka napíše:

Toto je komentár

.

Netradičný prístup

Okrem klasických metód môžete kód komentovať v HTML pomocou konkrétnych metód. V tele stránky sú okrem základných jazykových štruktúr HTML často uvedené aj skriptovacie a štýlové značky. Každý z nich má tiež svoje vlastné definície komentárov.

Ak teda uzavriete potrebnú časť kódu do jednej zo zadaných značiek, potom vo vnútri môžete použiť ďalšie metódy na komentovanie časti kódu na stránke HTML. V modernej praxi sa tieto metódy prakticky nepoužívajú, je však možné ich použiť na vlastný rozvoj alebo, ak je to potrebné na vylúčenie možného vzhľadu textu na stránke.

Pri použití značky skriptu alebo šablóny so štýlmi môžu byť komentáre jednoriadkové alebo viacriadkové. Prvé sú definované konštrukciou „//“, ktorá od okamihu napísania týchto znakov komentuje zvyšok riadku. Na skrytie časti kódu by ste mali použiť popis syntaxe „ / *“ na otvorenie a „ * /“ na zatvorenie komentára. Ak nie je za znakmi „/ *“ napísaný záverečný konštrukt, celý zostávajúci kód HTML bude okomentovaný.

Predložený príklad ukazuje spôsob neštandardného komentovania:

/*

Это комментарий.

*/