Y a-t-il un avantage à utiliser les commentaires PHP par rapport aux commentaires HTML dans le code HTML?

Question

J'ai entendu quelqu'un dire qu'il y en a, alors je me demandais.

Commentaire HTML:

 <!-- Comment goes here. -->
 

Commentaire PHP:

 <?php // Comment goes here. ?>
 

Answer 1

Contrairement aux commentaires HTML, les commentaires PHP ne figurent pas dans le résultat final. C'est souvent souhaitable, car les commentaires sont généralement des notes internes qui ne concernent personne.

Answer 2

Les commentaires PHP ne seront pas visibles dans le code source du client, contrairement aux commentaires HTML. La question est donc la suivante: voulez-vous que le commentaire soit lisible par l'utilisateur final?

Answer 3

Les commentaires PHP n'apparaissent pas dans le code HTML de sortie, contrairement à d'autres utilisateurs. Cela a 2 effets principaux:

1. Les commentaires PHP sont cachés de l'utilisateur final. Cela a déjà été couvert ... Et,
2. Les commentaires PHP ne sont pas envoyés sur Internet. Cela se traduira par une légère amélioration des performances pour l'utilisateur final. L'avantage de cela dépend bien sûr de votre verbosité.

Answer 4

Petits commentaires HTML peut être utile pour les développeurs, par exemple en précisant l'identifiant de balise de fermeture dans les gros fichiers:

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

Ces commentaires peuvent être extrêmement utiles, et ont peu ou pas d'effet sur la taille de la page.

PHP les commentaires doivent être maintenus à un minimum dans votre affichage de code, car il ne devrait pas être un tas de PHP à commenter (même si c'est un tout autre sujet).

Il va sans dire que vous ne devriez jamais commentaire PHP avec PHP commentaires, et HTML avec des commentaires HTML. Si jamais vous vous trouvez avoir à écrire de longs commentaires en HTML pour expliquer certains excentrique HTML de votre front-end, les développeurs, c'est probablement un mauvais signe.

Answer 5

Dépend vraiment de ce que vous commentez. En plus de toutes les autres réponses, j'ai quelque chose qui peut vraiment d'importance. De temps à autre, nous codeurs aurait besoin de commenter un bloc de code comme:

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

Supposons que la longueur de la $results est de 20 et le caractère de la longueur de chaque div est d'environ 500 Octets (moyennement dense div). Puis nous avons 10 KO de HTML ici. Dans ce cas, les deux commentant les méthodes serait très, très différents:

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

Zéro octet est envoyé au visiteur et il n'y a pas de PHP de traitement.

vs

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

10 KB est envoyé pour le visiteur et le PHP s'exécute cet énorme-y en boucle pour rien.

Bien sûr, si vous utilisez un système de gestion de versions (par exemple, git, svn), de tels commentaires (les commentaires à l'exécution de code plutôt que des descriptions) devrait vraiment être purement et simplement supprimée.