Gibt es Vorteile bei der Verwendung von PHP-Kommentaren gegenüber HTML-Kommentaren im HTML-Code? [closed]

Ich hörte jemanden sagen, dass es das gibt, also wunderte ich mich.

HTML-Kommentar:

<!-- Comment goes here. -->

PHP-Kommentar:

<?php // Comment goes here. ?>

Im Gegensatz zu HTML-Kommentaren werden PHP-Kommentare nicht in der endgültigen Ausgabe angezeigt. Das ist oft erwünscht, da Kommentare meist interne Notizen sind, die niemanden etwas angehen.

PHP-Kommentare sind im Quellcode des Clients nicht sichtbar, HTML-Kommentare jedoch. Die Frage ist also: Möchten Sie, dass der Kommentar für den Endbenutzer lesbar ist?

PHP-Kommentare werden nicht im Ausgabe-HTML angezeigt, wie andere Benutzer angegeben haben. Dies hat zwei Haupteffekte:

1. Die PHP-Kommentare sind vor dem Endbenutzer verborgen. Dies wurde bereits behandelt … Und,
2. Die PHP-Kommentare werden nicht über das Internet gesendet. Dies führt zu einem kleinen Leistungsschub für den Endbenutzer. Der Nutzen davon hängt natürlich von Ihrer Ausführlichkeit ab.

Kleine HTML-Kommentare können für Frontend-Entwickler nützlich sein, um beispielsweise die Kennung eines schließenden Tags in großen Dateien anzugeben:

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

Diese Kommentare können sein äußerst hilfreich und wirken sich kaum oder gar nicht auf die Seitengröße aus.

PHP-Kommentare sollten in Ihrem Anzeigecode auf ein Minimum beschränkt werden, da es nicht sehr viel PHP zum Kommentieren geben sollte (obwohl dies ein ganz anderes Thema ist).

Es versteht sich von selbst, dass Sie PHP immer nur mit PHP-Kommentaren und HTML mit HTML-Kommentaren kommentieren sollten. Wenn Sie jemals lange HTML-Kommentare schreiben müssen, um Ihren Front-End-Entwicklern etwas skurriles HTML zu erklären, ist das wahrscheinlich ein schlechtes Zeichen.

Es hängt wirklich davon ab, was Sie kommentieren. Zusätzlich zu allen anderen Antworten habe ich etwas, das wirklich wichtig sein kann. Von Zeit zu Zeit mussten wir Programmierer einen Codeblock auskommentieren wie:

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

Nehmen Sie an, dass die Länge von $results ist 20 und die Zeichenlänge jedes div beträgt etwa 500 Bytes (ein mäßig dichtes div). Dann haben wir hier 10 KB HTML. In diesem Fall wären die beiden Kommentarmethoden sehr, sehr unterschiedlich:

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

Null Bytes werden an den Besucher gesendet und es findet keine PHP-Verarbeitung statt.

vs

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

10 KB werden immer noch an den Besucher gesendet und PHP führt diese riesige Schleife umsonst aus.

Wenn Sie ein Versionskontrollsystem verwenden (z. B. Git oder Subversion), sollten solche Kommentare (Kommentare, die eher den laufenden Code als Beschreibungen abdecken) wirklich vollständig gelöscht werden.

Manchmal sind HTML-Kommentare nützlich, wenn Sie Informationen benötigen, die vom Browser nicht in HTML wiedergegeben werden können.

Beispielsweise müssen Sie die IP-Adresse des Servers kennen, der die HTML-Seite gesendet hat, Sie können sie nicht auf der HTML-Seite anzeigen … Sie drucken sie als HTML-Kommentar, damit Sie diese Informationen im HTML-Quellcode überprüfen können.