Comment rédiger des commentaires en code HTML. Que sont les commentaires en HTML

Bonne journée à tous, mes chers amis. Je suis très heureux de vous voir sur les pages de mon blog et j'espère que vous êtes également intéressé à être ici. Au moins, j'essaie de faire en sorte que ce soit ainsi. Et aujourd'hui, j'ai pour vous un sujet simple sur la création de sites Web, dont l'utilisation n'affectera en rien le site lui-même, mais permettra à vous et aux autres utilisateurs de « bricoler le code » plus facilement.

Aujourd'hui, nous allons parler des commentaires HTML dans le code. Ce truc est très cool. Et même si ce n’est pas obligatoire, je vous encourage quand même à utiliser ces choses. Ce n'est un secret pour personne que j'ai commandé la conception et la mise en page de mon blog à des personnes distinctes : Yulia et Andrey.

Alors, parfois, j'ai envie de corriger quelque chose dans le code, et afin de ne pas déranger encore une fois le maquettiste pour des bagatelles, je vais moi-même chez l'éditeur et corrige moi-même le code (si c'est en mon pouvoir). Et les commentaires qu'Andrey a laissés dans le code rendent les choses beaucoup plus faciles ce processus. De plus, les commentaires sont utiles si vous avez fait votre travail et êtes parti. Une autre personne pourra alors comprendre votre code plus rapidement.

Eh bien, voyons maintenant comment les réaliser en utilisant un exemple concret :

  • Passons à n'importe quel document HTML contenant du contenu.
  • Maintenant, mettez , avant toute entrée, sinon tout le contenu de la page deviendra un gros commentaire)).
  • En réalité, cela ressemble à ceci :

    Eh bien, maintenant, si nous enregistrons le document et l'ouvrons dans le navigateur, que verrons-nous ? Et nous ne verrons rien. Ou plutôt, nous ne verrons aucun changement, puisque tout ce qui se trouve à l'intérieur devient automatiquement invisible pour le navigateur.

    Et au fait, je vais maintenant vous parler d'un très utilisation actuelle ces balises en utilisant votre propre exemple. Lorsque le maquettiste a créé un site Web pour moi, selon les conditions de conception, deux bannières se trouvaient dans la barre latérale droite, ou plutôt à des endroits spéciaux pour elles. Je ne vais pas encore installer de banderoles, j’ai donc décidé de les retirer pendant un moment pour que mes yeux ne deviennent pas une horreur.

    Naturellement, je n’avais pas l’intention de les supprimer du code, mais comment puis-je les supprimer alors ? Bien sûr, vous pouvez copier ce code ou le script dans un document séparé et supprimez tout du site. Mais il existe une meilleure façon. Je viens de mettre tous ces codes dans les commentaires.

    Ainsi, je n'ai rien supprimé, mais je l'ai simplement caché pendant un moment. Tout récemment, j'ai créé une bannière pour mon concours de blog. Et donc je suis entré dans le code, j'ai mis une bannière, j'ai écrit le chemin dans le code et j'ai supprimé les balises de commentaire. Comme vous pouvez le constater, tout fonctionne à merveille.

    En général, vous comprenez, j'espère. Si vous devez masquer quelque chose sans le supprimer, il est préférable de tout mettre dans un commentaire.

    Eh bien, c'est là que je termine mon article d'aujourd'hui. Comment l'aimez-vous? Les informations ont-elles été utiles ? Si oui, assurez-vous de vous abonner aux mises à jour des articles de mon blog. De plus, pour étudier pleinement la mise en page d'un site Web à l'aide de HTML et CSS, je vous recommande de regarder un excellent cours sur ce sujet. Le cours n'est qu'une bombe, et tout est superbement raconté, littéralement mâché.

    Eh bien, je vous dis au revoir pour aujourd'hui. N'oubliez pas de visiter mon blog pour ne pas manquer les informations qui vous intéressent. Eh bien, je vous souhaite du succès dans tous vos efforts. Rendez-vous dans mes autres articles. Bye Bye!

    Cordialement, Dmitri Kostin.

    Je vais commencer cet article par à quoi servent les commentaires. Supposons que vous développez un module avec une structure complexe. Ou vous créez une mise en page avec de nombreux éléments imbriqués. Dans de tels cas, il est préférable de marquer certaines sections du code d'une manière ou d'une autre - c'est à cela que servent les commentaires.

    Je vais maintenant montrer en détail quatre types de commentaires, ou plutôt tous leurs types pour quatre codes différents.

    Commentaires dans le balisage HTML

    Pour ajouter un commentaire au balisage HTML, utilisez :

    Tout ce qui apparaît dans ces balises n'est pas visible à l'écran, mais est disponible pour visualisation dans le code source.

    Commentaires dans les styles CSS

    Pour ajouter un commentaire aux styles CSS, utilisez :

    Tout ce qui apparaît dans ces balises n'est pas pris en compte lors de la création des styles, mais est disponible pour visualisation dans le fichier de styles lui-même.

    Commentaires dans le code JavaScript

    Il existe deux types de commentaires pour ajouter des commentaires en JavaScript.

    Premier type :

    // Texte, code ou autre

    Deuxième type :

    /* Texte, code ou autre */

    Tout ce qui se trouve dans ces balises n'est pas pris en compte lors de l'exécution du script, mais est disponible pour visualisation dans le fichier JavaScript lui-même.

    Commentaires dans le code PHP

    Ce langage de programmation, contrairement aux précédents, dispose de 3 types de commentaires.

    Premier type :

    // Texte, code ou autre

    Deuxième type :

    /* Texte, code ou autre */

    Et le troisième type :

    # Texte, code ou autre

    Tout ce qui apparaît dans ces balises n'est pas pris en compte lors de l'exécution du script et n'est visible que dans le fichier PHP lui-même.

    Note!

    /* /* Mon code */ */

    vous donnera une erreur.

    Lorsque vous travaillez en tant que programmeur, vous devez constamment prendre des notes sous forme de commentaires afin de décrire une partie du code ou de prendre des notes pour le futur. Chaque langage a sa propre syntaxe, c'est pourquoi lors du développement de pages Web Problème commun Parfois, vous ne savez pas comment commenter une ligne ou un petit bloc en HTML.

    Commentaires en HTML

    Lors du développement d'une page Web, il est parfois nécessaire de masquer temporairement une partie du code ou de faire une note pour le programmeur. Afin de ne pas utiliser applications supplémentaires Par exemple, lorsque vous déplacez une partie du code vers un autre fichier, vous devez savoir comment commenter une ligne en HTML.

    Contrairement à la plupart des langages de programmation, HTML n'a pas fonction spéciale ou une balise pour créer un commentaire sur une ligne. Si vous devez « masquer » seulement une ligne ou une partie de celle-ci, vous devez utiliser les outils du langage classique. Cependant, il existe plusieurs façons de procéder.

    Commentaire standard

    DANS Langage HTML Le moyen le plus simple de commenter une partie du code consiste à utiliser des paires de caractères spéciales. Avant de commencer un commentaire, vous devez préciser "". Ainsi, tout ce qui se retrouve à l’intérieur de cette structure sera caché à l’utilisateur lors du chargement de la page.

    Il convient de noter que lorsque vous travaillez avec un commentaire, vous devez être extrêmement prudent. Lors de la détermination de ses limites, vous devez vérifier si une balise d'ouverture ou de fermeture y est incluse, dont la deuxième partie reste en dehors de ses limites - dans ce cas, la page ne se chargera pas correctement. Vous ne pouvez pas non plus créer plusieurs commentaires supplémentaires dans un seul commentaire : lorsqu'il est écrit de cette façon, le premier signal pour compléter une partie du commentaire révélera toute la partie suivante du texte masqué.

    Voici un exemple d’orthographe correcte :

    Ceci est un commentaire.

    Étiqueter

    En HTML, vous pouvez commenter les lignes à l'aide d'une paire de balises spéciale - . Il est spécifiquement inclus dans la syntaxe du langage à cet effet, mais la plupart navigateurs populaires ne supportent pas son fonctionnement, sauf Internet Explorer 8.0. La balise est utile à utiliser lorsque certaines informations doivent être masquées uniquement pour les navigateurs IE 8.0, 4.0 et plus. versions précédentes, et également comme solution temporaire pendant le développement. Le point précis ici est que vous pouvez commenter une partie du code uniquement dans le corps de la page, c'est-à-dire à l'intérieur de la balise.

    Dans l'exemple ci-dessous, lorsque la page se charge navigateurs spécifiés sera retiré Liste blanche, dans d'autres programmes, la page dira :

    Ceci est un commentaire

    .

    Approche non standard

    En plus des méthodes classiques, vous pouvez commenter du code en HTML à l'aide de méthodes spécifiques. En plus de la langue principale Structures HTML, le corps de la page contient souvent des balises de script et des balises de feuille de style. Chacun d'eux a également ses propres définitions de commentaires.

    Ainsi, si vous placez la partie requise du code dans l'un des balises spécifiées, puis à l'intérieur, vous pouvez utiliser d'autres méthodes pour Page HTML commentez une partie du code. De telles méthodes ne sont pratiquement pas utilisées dans la pratique moderne, cependant, pour l'auto-développement ou, si nécessaire, pour exclure l'apparition éventuelle de texte sur la page, elles peuvent être utilisées.

    Lorsque vous utilisez une balise de script ou une feuille de style, les commentaires peuvent être sur une seule ligne ou sur plusieurs lignes. Les premiers sont définis par la construction « // » qui, à partir du moment où ces caractères sont écrits, commente toute la ligne restante. Afin de masquer une partie du code, vous devez utiliser la description syntaxique "/*" pour ouvrir et "*/" pour fermer le commentaire. S'il n'y a pas de construction de fermeture après les symboles "/*", alors tout le code HTML restant sera commenté.

    L'exemple présenté montre une méthode de commentaire non standard :