Есть ли какая-либо польза в использовании комментариев PHP над комментариями HTML в HTML-коде?

Ответ 1

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

Ответ 2

Комментарии PHP не будут отображаться в источнике на клиенте, где будут комментарии HTML. Поэтому возникает вопрос: хотите ли вы, чтобы комментарий читался конечным пользователем?

Ответ 3

Комментарии PHP не отображаются в выходном HTML, как заявили другие пользователи. Это имеет 2 основных эффекта:

• Комментарии PHP скрыты от конечного пользователя. Это уже было рассмотрено... И,
• Комментарии PHP не отправляются через Интернет. Это приведет к некоторому увеличению производительности для конечного пользователя. Преимущество этого, конечно, зависит от вашей многословности.

Ответ 4

Маленькие HTML-комментарии могут быть полезны для интерфейсных разработчиков, например, указывая идентификатор закрывающего тега в больших файлах:

<div id="container">
    ... Hundreds or thousands of lines of HTML
</div> <!-- #container -->

Эти комментарии могут быть чрезвычайно полезны и мало или совсем не влияют на размер страницы.

Комментарии PHP должны быть сведены к минимуму в вашем отображаемом коде, потому что не должно быть большого количества PHP для комментариев (хотя это совсем другой предмет).

Само собой разумеется, что вы должны только комментировать PHP с комментариями PHP и HTML с комментариями HTML. Если вам когда-либо приходится писать длинные HTML-комментарии, чтобы объяснить некоторые изворотливые HTML файлы для ваших разработчиков, это, вероятно, плохой знак.

Ответ 5

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

<?php foreach ($results) { ?>
  <div>
    ... more divs ...
  </div>
<?php } ?>

Предположим, что длина $results равна 20, а длина символов каждого div составляет около 500 байт (умеренно плотный div). Тогда у нас есть 10 КБ HTML. В этом случае два метода комментариев будут очень разными:

<?php /* foreach ($results) { ?>
  <div>
    ... more divs ...
  </div>
<?php } */ ?>

Нулевые байты отправляются посетителю, и нет обработки PHP.

против

<!-- <?php foreach ($results) { ?>
  <div>
    ... more divs ...
  </div>
<?php } ?> -->

10 КБ по-прежнему отправляется посетителю, а PHP запускает этот цикл с огромным циклом y для ничего.

Конечно, если вы используете систему контроля версий (например, git, svn), такие комментарии (комментарии, которые охватывают текущий код, а не описания) действительно должны быть удалены вообще.

Ответ 6

Иногда html-комментарии полезны, когда вам нужно получить информацию, которую браузер не может отобразить в html.

Например, вам нужно знать IP-адрес сервера, который отправил html-страницу, которую вы не можете показать на странице html.. вы печатаете ее как комментарий html, чтобы вы могли проверить эту информацию в исходном HTML-тексте