…сегодня мы в этой коротенькой, но полезной статье, разберемся, как же комментируется различный программный код. Много говорить не стану, ибо если вас подобное заинтересовало, то вы уже столкнулись с вопросами этой задачи, и представление о ней имеете.
Вы зашли по адресу… но несколько слов для ясности и пользы дела. Наверняка видели, как это делается с CSS-кодом , так как сss представляет наибольший интерес у многих начинающих, как и я.
… Хорошо!
Но обратите внимание, что комментарии используются также и в html и php … А ведь большинство начинающих путаются на начальном этапе своей работе с сайтом и не знают, как дописать себе необходимые пояснения. Ведь бывает же так, например, вам потребуется на какое-то время деактивировать код html , а потом снова возобновить его функцию — это запросто реализовать, если вы сделали себе пометки на «полях», да мало ли что.
Но что следует помнить о «комментариях» вообще — тут всё в строгой зависимости от того, с каким файлом вы работаете конкретно, а следовательно и код применения различен.
Комментируем код CSS
a:hover, a:focus { color: #D5071E; text-decoration: Overline; /*ПОДЧЁРКИВАНИЕ ВВЕРХУ*/ }Таким образом вы делаете себе пояснение. Или можно вообще закомментировать этот скрипт css так: просто оберните
/* здесь КОД */
/*a:hover, a:focus { color: #D5071E; text-decoration: underline; /*ПОДЧЁРКИВАНИЕ ВНИЗУ*/ }*/
Обращаю ваше внимание на то, что — закомментировать полный цикл кода css таким способом можно, но!! тогда придётся убрать повторные комментарии /*ПОДЧЁРКИВАНИЕ ВНИЗУ*/ , или поиграть слэшами, если пояснение важно))
Иначе будет ошибка!!
Ко сведению:
Если открыть исходный код страницы — Ctrl+U и взглянуть… то увидим, что закомментированный кусок кода css замечательно отображается в сгенерированном документе! это если css использовалось (задавались свойства) прямо в html
И, как понимаете, если перейти из исходного кода по ссылке в документ css вашего активного шаблона — все комментарии можно наблюдать и изучать)) если кому-то потрэбу. Но это вряд ли)
Английское наречие (слова) будут читаемы. Русская символика — нет.
Комментируем код HTML
Аналогично комментируется и файл XML
Важно: всегда проверяйте предлагаемый в статьях код, хотя бы запросто — визуально) иначе могут быть ошибки.
Обычная невнимательность при форматировании может стоить времени, например, показанный выше ЗАКОММЕНТИРОВАННЫЙ код частенько бывает ошибочен: заместо двух коротких дефисов вырисовывается длинное тире:
К сведению же:
как говорилось в предыдущей ремарке — так же и закомментный… код html отображается в сгенерированном документе!
Имейте в виду это.
И вот ещё что:
помимо того, что комментированный код отображается в исходном коде страницы (а значит и отрабатывается в каком-то смысле, хотя и на страничке будет невидим!) — какие-то функции php связкой с html лучше выносить из активного документа.
Например:
будет виден в документе и функция замечательно отработает своё дело: т.е во фронтенде информации станет не видать, но вот в исходнике — она чётко отобразится! и это беспонтовый запрос к БД: всё это мелочь, но знать надобно!
Возможно поступить так, если выносить кусок кода из документа не хочется:
добавьте перед необходимым «лишним» html кодом открывающий … встроенная функция… и закрывающий?> …
Словом, вот так можно поступить, если код большой:
тогда исходник будет чистеньким!
Или попроще:
Закомментируем саму функцию в документе html . Исходник в этих случаях относительно отработок функций будет чистеньким!
как закомментировать JavaScript
if (beingShown || shown) { // don"t trigger the animation again return; } else { // в строке применяем ЛЮБОЙ КОММЕНТАРИЙ // в строке применяем ЛЮБОЙ КОММЕНТАРИЙ // true;Этот пример-код JavaScript, - я, для наглядности, ухватил в нете, слегка поправив пунктуацию. Это неважно… Главное понять принцип…
Как вы понимаете слеш «// » двойной, это и есть ЗНАК комментария… ОДНОСТРОЧНЫЙ!
А в остальном код JS комментируется подобно php , об этом ниже:
ремарка:
Комментируем код PHP
…и …здесь аналогично – слеш-слеш… однострочный.Но обратите внимание, что его можно комментировать так, как и код-CSS.
…либо так можно закомментировать — однострочный вариант, когда используем НЕ ДВА СЛЕШ, но БЕКАР (решётка) перед комментируемой строкой:
…Естественно, комментировать нужно осторожно в цикле кода!
…либо же таким образом — аналогично показанному выше примеру для CSS… т.е. этот /* код */ вариант комментирования подойдёт и для CSS и для JS кодов!
А вот таким образом можно закомментировать более объёмное пояснение к коду PHP, где-то меж его основными примерами…
Ещё в циклах php можно комментровать и так, коли код смешанный… php и как-то html
Аналогично описанному выше:
К примеру какая-то такая функция… где-то в общем коде (или цикл в html): — можно закомментировать, т.е добавить свою метку так:
или так: однострочный вариант…
Сведения:
php код не виден ни в каких исходных кодах!! виден только его функциональный результат — отработка!
Вот в общем и всё что хотелось нынче доложить!
Теперь можете поэкспериментировать… Удачи.
И конечно же, читайте статьи сайта и подписывайтесь:
Делюсь горьким опытом - кое-какими знаниями, для вашего сладкого благополучия))
...город веб мастеров Михалика.ru
© - запросто с WordPress
Михаил 2016-05-05 1 HTML и CSS 2
Как писать в html комментарии в коде?
Сегодня я вам расскажу, как делать в html комментарии в коде. Комментарии — это очень полезная вещь. Они никак не влияют на выполнение кода и внешний вид страниц, а еще их не увидеть в исходном коде страницы. По сути, комментарии можно увидеть только открыв файл в редакторе. У меня в Notepad++ они подсвечиваются зеленым цветом.
Как оставлять в html комментарии?
Очень легко. Синтаксис комментария в языке разметки выглядит следующим образом:
Таким образом, можно закомментировать не только одну строку, но и несколько. Главное запомнить, что — закрывающая. Внутри такой конструкции вы можете использовать как просто поясняющий текст, а и теги в угловых скобках, браузер их не будет читать.
Как я уже говорил, комментарий имеет такие особенности:
- его не видно на странице
- и в исходном коде тоже нет, а только при редактировании файла
- все теги, которые помещены в него, никак не будут обработаны браузером
Для чего это нужно
Основная цель комментариев — помочь другим разработчикам. При верстке вы можете явно указывать, какая часть кода формирует шапку, а какая — основную часть. Конечно, опытные верстальщики и без этого бы разобрались, но все равно чтение и понимание кода улучшается. А еще комментарии помогают людям, которые плохо понимают html, все-таки хоть немного разобраться в написанном. Вот пример их использования:
Второе возможное применение комментария — сделать неактивным на время какой-то кусок кода, когда не хотелось бы его удалять, но нужно как бы сделать его выполнение неактивным. Кстати, это может помочь выявить различные ошибки в верстке.
Вообще одно их хороших качеств любого веб-разработчика — это умение писать красиво оформленный и понятный код. Это означает, что нужно использовать отступы, показывая вложенность элементов, также при необходимости оставлять комментарии, разделять переносами строк основные части документа и т.д. Все это помогает тем, кто будет в будущем редактировать код, а также самому автору, который не потеряется в своем же творении.
Прежде чем научиться делать комментарии в html, нужно разобраться, для чего они нужны. Если вы интересуетесь такой информацией, то наверняка уже в курсе, поэтому останавливаться на этом вопросе мы не будем. Некоторые не уделяют должного внимания расстановке комментариев в своих кодах. В одностраничных сайтах такая ошибка, может, и останется незамеченной. Но когда речь заходит об огромных порталах, небольшие комментарии будут экономить время и упрощать вашу жизнь. Плюс ко всему заметки позволяют другим разработчикам понимать ваш код, когда требуется дополнительное объяснение.
Цель
Создание html-страницы порой не обходится без запутанных кодов и вечно повторяющихся тегов. Новые классы, селекторы, id-индификаторы и т.д. Все это может в прямом смысле свести с ума. Комментарии в html созданы, чтобы облегчить тяжелую участь веб-разработчиков. Ведь когда код сайта тянется далеко вниз, то трудно бывает вспомнить, что и где находится. Именно комментарии помогают сделать небольшие заметки прямо в html-коде, которые не будут видны вашим пользователям. Новички редко используют этот тег. Но уж опытные специалисты выделяют огромное, полезное свойство комментариев. Особенно эффективен этот тег, когда работу над кодом производят сразу несколько разработчиков. Вместо того чтобы каждый раз задавать вопросы и отрывать своего напарника от работы, нужно просто просмотреть комментарии.
Создание
Чтобы в вашем коде появилась новая строчка с комментарием, необходимо добавить следующую запись: . Именно так выглядит в html этот тег. Все, что находится внутри него, не будет выведено на экран пользователей. Html-комментарии не должны растягиваться на несколько строчек и содержать в себе какой-либо код (это считается дурным тоном). Они должны нести в себе лишь некоторое описание намерений разработчика относительно вставки именно этого тега, атрибута или значения. Хотя среди высокого уровня мастеров бытует мнение, что код должен записываться таким образом, чтобы никаких дополнительных объяснений не требовалось. Но, к сожалению, не все обладают таким даром написания html-страниц.
Особенности
Тег имеет некоторые свои особенности. Например, внутрь него можно добавлять любые другие теги, но нельзя создавать вложенные комментарии. Это приведет к не совсем ожидаемому результату. Комментарии в html широко используются для тестирования веб-страниц. Например, когда нужно посмотреть на сайт без определенного тега, но удалять его нельзя, так как будет трудно восстановить весь исходный код. В этом случае нужно просто поместить необходимую часть страницы в комментарии. И тогда тег будет проигнорирован браузером. Но стоит заметить, что все комментарии можно проследить, если открыть исходный код страницы. А это может сделать каждый пользователь. Поэтому не стоит помещать какую-либо важную информацию внутрь данного тега.
В данном уроке я расскажу о том, как делаются комментарии в HTML, CSS, PHP . Комментарии представляют собой текст, который не виден на веб-странице. Они используется для разного рода пояснений, напоминаний, описаний для вебмастеров, что позволяет структурировать документ. Комментарии незаменимы при отладке кода, позволяют быстро сориентироваться в разметке веб-страницы и найти нужный блок. Часто комментарии применяются для отладки кода HTML. К примеру, можно временно закомментировать конкретный блок кода, чтобы он не исполнялся, а в случае необходимости легко его восстановить.
Комментарии в HTML
В HTML комментарии формируются с помощью символов: . Таким образом, любой текст, находящийся между этими символами, является комментарием. Рассмотрим пример:
Пример комментариев в HTML
Комментарии в CSS
Комментарии в CSS создаются с помощью символов: /* и */. Для создания комментария нужно просто поместить код-веб страницы между этими символами:
/* Начало блока со стилями для Body*/ body { background: #efeded; font-family: Verdana, Helvetica, sans-serif; font-size: 12px; margin: 0px; padding: 0px; } /* Конец блока со стилями для Body*/
Комментарии в PHP
Комментарии в PHP могут быть однострочными и многострочными:
1) Однострочные комментарии в PHP создаются с помощью символов: //. Достаточно просто поставить этот символ перед строкой и она будет закомментирована.Такой вариант применятся в том случае, когда комментарий состоит только их одной строки.
2) Для реализации многострочных комментариев используются символы: /* и */. Такой вариант полезен, если комментарий занимает несколько строк.
Таким образом, мы научились делать
Программы и игры
