Коментари в html и php. Коментари в HTML, CSS, PHP

25.04.2017


Здравейте!
Продължаваме да учим основите на PHP от нулата!
В този урок ще ви кажа какво представлява коментарът в PHP и на практика ще се опитаме да напишем вашия коментар в кода. Но това не е всичко. Искам също да ви кажа как да коментирате кода и защо изобщо трябва да го направите.

В какво е коментарPHP
Коментирайте вPHPе подсказка за php-разработчик за бърза ориентация в кода, както и за редактиране.

Коментар в PHP не се вижда от потребителя, който е отворил уеб страницата за преглед. Дори ако потребителят реши да разгледа изходния код на страницата, коментарът пак няма да бъде видим, тъй като всички php.

Коментар на PHP код

Има 2 вида коментари за PHP код:

→ еднолинеен
→ многоредов

⇒ Едноредов коментар за PHP
За едноредов коментар използвайте знаците "//" или "#"

След тези знаци всичко написано на един ред ще бъде игнорирано и ще се третира като коментар.

Абонирайте се за актуализация"; # абонирайте се (това е коментар) ?>


Абонирайте се за актуализация

⇒ Многоредов коментар за PHP
Многоредов коментар за PHP започва с "/*" и завършва с "*/".
Всичко между тези знаци ще бъде игнорирано и ще се третира като коментар.
Многоредов коментар се използва, ако има няколко реда в записа.

На екрана ще видите само следния текст:

Здравейте читатели на блога - сайта !!!

P.S.:Винаги коментирайте кода си. Ако си мислите, че ще запомните всичко, което сте правили в кода след 1-2 години, грешите, шансът е много малък. Дори и да си спомняте, ще трябва да отделите много време в изучаване - какво, къде и защо ...
Направете бъдещето приятно за себе си - коментирайте кода и тогава ще си кажете "БЛАГОДАРЯ!!!".
Оставете коментар в кода, това ще отнеме 1 минута от времето ви, но ще ви спести цял ден в бъдеще.

Коментирайте PHP код

Да приемем, че сте написали php код, но по някаква причина трябва да премахнете 2 реда от кода.
Не бързам да премахвам нещо от кода, особено ако е php код, по-добре да го коментирам. И изведнъж ще се наложи да върнете кода. По-лесно е да декомментирате, отколкото да пишете код по нов начин.

Как да коментирате кодаPHP
Пример с едноредов коментар:

Абонирайте се за актуализация"; ?>

Пример с многоредов коментар.

От автора:коментирането е една от онези функции, които са лесни за изпълнение. В същото време тези елементи за редактиране могат да бъдат от голяма полза за разработчиците, които предават код от ръка на ръка. Днес ще научите как да коментирате блок в PhpStorm. Ще разгледаме и останалата част от функционалността на средата за разработка за коментиране на съдържанието на програмата.

Коментари: добри и лоши

Възможността за коментиране на код е налична в повечето езици за програмиране (вероятно всички, но с различна степен на наличност). Обикновено устните разяснения се използват, за да помогнат на други членове на екипа с по-нататъшното развитие или просто за да си напомнят, че тази област се нуждае от поправки („FIX ME“).

Разбира се, обяснението на написаното е благословия. Но с помощта на коментари можете да зачеркнете всички добри страни на кода. За да предотвратите това да се случи, е необходимо да правите разлика между видовете коментари:

документиране. Добра асоциация би била концепцията за документация за различен софтуер. Такива коментари помагат при използването на кода, като инструкция. Подобно коментиране не се възприема като излишно, защото без него няма как. Представете си, че някой е използвал авторската рамка и не ви казва как да използвате програмата;

JavaScript. Бърз старт

обяснителен. Добрият код обикновено не се нуждае от тях. Колкото повече редове с коментари виждате в дадена програма, толкова по-вероятно е програмата да е лошо написана. Разбира се, това не е абсолютно правило.

Обяснителните коментари могат да бъдат полезни за тези, които ще коригират кода в бъдеще. Например, много млади специалисти виждат място за подобрение навсякъде. Те вярват, че преди тях всичко е било по-лошо и сега е време да поправят всяка една функция.

Понякога подобно чувство завладява професионалистите. Например, когато всичко изглежда изненадващо криво – трябва да има по-добро решение. За да предпази последователите да търсят нещо по-добро, програмист може да остави бележка като тази: #time_spent_here=24h

След такива думи малко хора искат да прекарват толкова много време. По този начин вие предупреждавате, че много различни опции вече са подредени. В същото време трябва да избягвате такива атаки: #i_hate_this, #try_to_do_do_do_ass%%le. По този начин показвате само непрофесионално отношение. Не правете компромис със себе си и работодателя.

Но документирането на коментиране на код също може да стане баласт за програмист. По правило това са масивни секции, които отвличат вниманието директно от програмирането. Но за показване на кода без коментари има съответна функция в основните IDE. Не трябва да бъде изключение и PhpStorm, но уви. Потърсете функцията в документите за актуализация.

Таг като елемент от функционалност

Въпреки че коментирането е замислено като пояснение и помощ за развитието на екипа, тези функции не се използват толкова често. По правило таговете се поставят там, където искат да спрат изпълнението на кода. Да приемем, че имате PHP, вграден в HTML. И вие не искате да го изтриете, вие просто искате да видите как изглежда страницата без него. За да направите това, трябва да следвате следния синтаксис:

JavaScript

...
...

…< div > . . . < / div >

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

< div > . . . < / div >

Както можете да видите, с прости действия можете да спрете изпълнението на кода, без дори да извършвате сложни операции. Но всъщност това все още не е върха на оптимизацията. Допълнително удобство за разработчика се осигурява от самата phpStorm IDE. С помощта на подчертаване и клавишни комбинации можете да коментирате избрания сегмент от кода, без да присвоявате специализирани тагове. Може да се направи така.

Използвайки удобен за вас метод, изберете част от текст (мишка, преки пътища).

Натиснете клавишната комбинация Ctr + Shift + /

Освен това можете да коментирате текущия ред. Все едно, само без Shift.

Предимството на този тип коментиране е едновременното отразяване на няколко езика. PHP е рядък сам по себе си. По този начин не е нужно да прибягвате до маркиране на всеки един. Средата поддържа още няколко уеб езика. Просто изберете фрагмент и продайте комбинацията - това е многоезичният код и е коментиран. По същия начин тя може да бъде активирана.

Това е всичко, което имаме. Ако не сте използвали тези функции преди, препоръчваме ви да започнете. Съкращенията правят работата по-бърза и по-добра.

JavaScript. Бърз старт

Научете основите на JavaScript с практически пример за изграждане на уеб приложение

Коментарите в PHP са подобни на коментарите, използвани в HTML. В синтаксиса на PHP коментарите винаги започват със специална последователност от знаци и всеки текст, който се появява между тези специални знаци, ще бъде игнориран от интерпретатора.

В HTML основната цел на коментара е да служи като бележка за разработчиците, които могат да видят изходния код на вашия сайт. PHP коментарите се различават по това, че няма да се показват на посетителите. Единственият начин да видите PHP коментари е да отворите файла за редактиране. Това прави PHP коментарите полезни само за PHP програмисти.

В случай, че сте забравили или не знаете как се правят коментарите в HTML, вижте примера по-долу.

Синтаксис на php коментар: едноредов коментар

Докато html има само един тип коментар, PHP има два типа. Първият тип, който ще обсъдим, е едноредовият коментар. Тоест коментар, който казва на интерпретатора да игнорира всичко, което се случва на този ред вдясно от коментарите. За да използвате този коментар, използвайте знаците "//" или "#" и целият текст вдясно ще бъде игнориран от PHP интерпретатора.

Psst...Не можете да видите моите PHP коментари!"; // echo "нищо"; // echo "Моето име е Хъмпърдинкъл!"; # echo "И аз не правя нищо"; ?>

Резултат:

Здравей свят! Psst...Не можете да видите моите PHP коментари!

Имайте предвид, че няколко от нашите команди за ехо не бяха обработени, защото ги коментирахме със специални символи за коментар. Този тип коментари често се използва за бързо писане за сложен и обфускиран код или за временно премахване на ред от PHP код (за целите на отстраняване на грешки).

Синтаксис на php коментар: многоредов коментар

Подобно на HTML коментарите, многоредовите коментари в PHP могат да се използват за коментиране на големи блокове код или за писане на коментари на няколко реда. Многоредовите коментари в PHP започват с "/*" и завършват с "*/". Всичко между тези знаци ще бъде игнорирано.

Резултат.

... днес сме в тази кратка, но полезна статия, ще разберем как се коментира различни програмни кодове. Няма да говоря много, защото ако се интересувате от това, значи вече сте се сблъсквали с въпросите на тази задача и имате представа за нея.


Попаднали сте на правилното място... но няколко думи за яснота и полезност. Сигурно сте виждали как се прави с CSS код, тъй като css е от най-голям интерес за много начинаещи, като мен.

… Добре!

Но имайте предвид, че коментарите също се използват в html и php... Но повечето начинаещи се объркват в началния етап от работата си със сайта и не знаят как да добавят необходимите обяснения към себе си. В крайна сметка това се случва по същия начин, например, трябва да деактивирате за известно време html код, и след това възобнови функцията си отново - това е лесно за изпълнение, ако сте направили бележки в „полетата“, но никога не знаете какво.

Но какво трябва да се помни за "коментари" като цяло - всичко тук е строго зависимо от кой файл конкретно работите и следователно кодът на приложението е различен.

Коментиране на CSS кода

a:hover, a:focus (цвят: #D5071E; текстова декорация: Overline; /*подчертаване в горната част*/)

Така се обяснявате. Или можете по принцип да коментирате този css скрипт по следния начин: просто обвийте

/* КОД тук */

/*a:hover, a:focus (цвят: #D5071E; текстова декорация: подчертаване; /*ДОЛНО ПОДЧЕРТАНЕ*/ )*/

Обръщам внимание на факта, че - можете да коментирате пълния цикъл на css код по този начин, но !! тогава ще трябва да премахнете повтарящи се коментари /* ПОД СТРИГА ПОДОЛУ */ или да играете с наклонени черти, ако обяснението е важно))

В противен случай ще има грешка!!

Забележка:

Ако отворите изходния код на страницата - Ctrl + U и погледнете ... ще видим, че коментираната част от css кода се показва перфектно в генерирания документ! това е, ако css е бил използван (свойствата са зададени) директно в html

И, както разбирате, ако следвате връзката от изходния код към css документа на вашия активен шаблон, можете да наблюдавате и изучавате всички коментари)), ако някой има нужда от него. Но това е малко вероятно.)

Английският диалект (думи) ще бъде четим. Руски символи - не.

Коментиране на HTML кода

XML файлът се коментира по същия начин.

Важно: винаги проверявайте кода, предложен в статиите, поне визуално, в противен случай може да има грешки.

Простата небрежност при форматиране може да струва време, например КОМЕНТИРАНИЯТ код, показан по-горе, често е грешен: вместо две кратки тирета се очертава тире:

За ваша информация:

както беше споменато в предишната забележка - такъв е и коментарът ... html кодът се показва в генерирания документ!

Имайте това предвид.

И ето още нещо:

в допълнение към факта, че коментираният код се показва в изходния код на страницата (и следователно се обработва в известен смисъл, въпреки че ще бъде невидим на страницата!) - по-добре е да премахнете някои php функции във връзка с html от активния документ.

Например:

ще се вижда в документа и функциятатой ще свърши работата си забележително добре: тоест в предния край информацията няма да се вижда, но в изходния код ще бъде ясно показана! и това е беспонтова заявка към базата данни: всичко това е дреболия, но трябва да знаете!

Възможно е да направите това, ако не искате да извадите част от кода от документа:

добавете преди необходимото "допълнително" отваряне на html код… вградена функция… и затваряне?> …

С една дума, това е, което можете да направите, ако кодът е голям:


**/ ?>

тогава източникът ще бъде чист!

Или по-просто:

Нека коментираме самата функция в html документа. Изходният код в тези случаи по отношение на разработването на функции ще бъде чист!

как да коментирам javascript

if (beingShown || показано) ( // не задействайте анимацията отново return; ) else ( // прилага ВСЯКАКЪВ КОМЕНТАР на реда // прилага ВСЯКАКЪВ КОМЕНТАР на реда // true;

Този примерен JavaScript код - аз, за ​​по-голяма яснота, грабнах в мрежата, леко коригирайки пунктуацията. Няма значение... Основното е да разберете принципа...

Както разбирате, наклонената черта “//” е двойна, това е ЗНАКЪТ на коментара ... ЕДИНИЧЕН!

А останалата част от JS кода се коментира като php, повече за това по-долу:

Забележка:

Коментиране на PHP кода

... и ... тук е подобно - наклонена черта-наклонена черта ... едноредова.

Но имайте предвид, че може да се коментира точно като CSS код.

... или можете да коментирате по този начин - едноредов вариант, когато използваме НЕ ДВЕ НАКЛАНИ ЧЕРЕЗИ, а BEKAR (хеш) преди коментирания ред:

…Разбира се, коментирането трябва да се прави внимателно в цикъла на кода!

... или по този начин - подобно на показания по-горе CSS пример ... т.е. тази /* код */ опция за коментиране е подходяща както за CSS, така и за JS кодове!

Но по този начин можете да коментирате по-обемно обяснение на PHP кода, някъде между основните му примери ...

Можете също да коментирате в php цикли, ако кодът е смесен ... php и някак си html

Подобно на по-горе:

Например, някаква такава функция ... някъде в общия код (или цикъл в html):- можете да коментирате, т.е. да добавите своя етикет по следния начин:

или така: еднолинеен...

интелигентност:

php кодът не се вижда в никакви изходни кодове!! се вижда само функционалният му резултат - отработка!

Това е всичко, което исках да докладвам днес!

Сега можете да експериментирате... Успех.

И разбира се, прочетете статиите на сайта и се абонирайте:
Споделям горчивия си опит - малко знания, за вашето сладко благополучие))

...градът на уеб администраторите Michalika.ru© - лесно с WordPress