Как закомментировать код в HTML, PHP, JavaScript, CSS? | Блог Костаневича Степана

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

Комментарии в PHP при выполнении скрипта игнорируются препроцессором, и нужны только для людей. Разработчики часто пренебрегают комментированием кода.

Среди программистов бытует мнение, что они вспомнят, как работает код, и через шесть месяцев и через год. Еще одна причина не оставлять комментарии — уверенность в том, что код настолько хорошо написан, что он ясен и без пояснений. Но нужно помнить, что может потребоваться продолжать поддерживать созданные скрипты PHP долгое время после написания.

Не менее важная причина комментирования кода — убедиться, что последователи поддерживают или добавляют функциональность вашему творению.

Комментарии в коде HTML, CSS, JavaScript, PHP

Они также получат пользу от чтения оставленных комментариев.

PHP предоставляет два способа комментирования: один — для однострочных комментариев, а второй — для многострочных. PHP заимствует синтаксис комментариев из C, C++ и Java. Так что, если вы знакомы с ними, то сюрпризов для вас не будет.

Однострочные комментарии PHP

Перед комментариями, которые находятся на одной строке, в PHP ставятся два символа косой черты (//).

Следующий пример содержит однострочный PHP комментарий в коде:

<?php // Это однострочный комментарий ?>

Однострочный комментарий может находиться на отдельной строке, или добавляется в конец строки кода:

<?php echo "Это проверочная строка"; // Вывести строку текста ?>

В примере, приведенном выше, препроцессор PHP выполнит функцию echo и проигнорирует все, что расположено после //.

Однострочные комментарии также применяются, чтобы временно убрать строки кода из потока выполнения.

Например, следующее изменение предыдущего примера приведет к тому, что PHP проигнорирует всю команду echo во время выполнения:

<?php // echo "Это проверочная строка"; ?>

Многострочные комментарии PHP

Многострочные комментарии для сайта PHP обернуты разделителями /* и */. Знак /* обозначает начало блока комментариев, а */ указывает на его конец. Следующий пример демонстрирует использование многострочного комментирования:

<?pre /* Это многострочный блок комментариев */ ?>

Многострочные комментарии полезны, когда заметки, которые вы хотите вставить в код, занимают более одной строки. Возможность помечать блоки строк как комментарии позволяет избежать использования однострочного комментария в начале каждой строки.

Другое полезное применение многострочных комментариев — временное отключение блоков кода PHP. Распространенная практика — написать PHP-скрипт и размышлять, можно ли переписать его так, чтобы он стал более эффективным. В данной ситуации можно закомментировать старый фрагмент кода, чтобы он больше не выполнялся, и написать новый. Если окажется, что новый код хуже оригинала, то можно в PHP удалить комментарии и новый код. А затем раскомментировать старый, чтобы вернуть его в поток выполнения.

Итоги

И однострочные, и многострочные комментарии можно легко добавить в PHP- код, используя специальный синтаксис. Постарайтесь выработать привычку комментировать свой код.

Теперь, когда мы усвоили некоторые базовые понятия PHP, настало время изучить основы этого языка программирования, начиная с введения в переменные PHP.

Перевод статьи «Commenting PHP Code» был подготовлен дружной командой проекта Сайтостроение от А до Я.

Как вставить комментарий в CSS код

Скажите, пожалуйста, можно ли как-то скопом закомментировать и HTML и PHP?

Есть, к примеру, код вида

==========
<html>

<body>

<!—  Тут код html <?php // тут код PHP ?> тут опять код HTML —>

</body>

</html>
==========

Если блок HTML большой, и в нем много внутреннего кода PHP — заколебешься это комментировать и разкоментировать. Может есть какой-то способ (тэг), позволяющий комментировать целиком весь блок? Или только автозамена в Notepad++ и никак больше?

Есть что-нибудь такое?

===============

<html>

<body>

[тут "волшебный" открывающий тэг, комментирующий блок]

  <div>Тут код html <?php тут код PHP ?> тут пять код HTML </div>

[тут "волшебный" закрывающий тэг]

</body>

</html>

===============

 
 

Комментарии в коде нужны, чтобы легче было ориентироваться разработчику, оставляя свои заметки о том, какую задачу решает тот или иной фрагмент.

HTML тег (комментарии)

На разных языках программирования они реализуются по разному. Их нельзя путать, иначе не выполнится скрипт, проигнорируются стили, на веб-странице проявится ненужный текст.

<!— комментарии HTML —>/* комментарии CSS, JavaScript, PHP */// однострочные комментарии JavaScript, PHP

В качестве примера возьмём скрипт из предыдущей статьи:

<style> #div {position: relative; padding-bottom: 25px;} #div:before { content: «Пример, twitter.com»; position: absolute; color: rgb(109, 109, 109); font-size: 80%; bottom: 0px; } </style> <div id=»div»> <img src=»https://rpilot62.ru/wp-content/uploads/2018/06/99296.jpg» id=»boldStuff2″ alt=»twitter.com»> <input id=»userInput» placeholder=»введите домен» type=»text»> <input onclick=»changeText2()» value=»применить» type=»button»> </div> <script> function changeText2(){ var userInput = «http://favicon.yandex.net/favicon/» + document.getElementById(‘userInput’).value; document.getElementById(‘boldStuff2’).alt = document.getElementById(‘userInput’).value; document.getElementById(‘boldStuff2’).src = userInput; } </script>

Следует помнить, что объёмный HTML замедляет загрузку страницы, поэтому комментариями в коде не стоит злоупотреблять.

Добавить комментарий

Закрыть меню