comment

Syntaxe

Paramètres

Description

Cette balise permet d'ajouter des commentaires dans le code Liquid sans qu'ils ne soient affichés dans le HTML généré.

Remarques

• Commentaires invisibles dans le HTML final : Contrairement aux commentaires HTML (<!-- -->), la balise {% comment %} permet de masquer complètement le texte ou le code qu'elle entoure dans le rendu final. Rien de ce qui se trouve entre les balises n'apparaîtra dans le code source du navigateur, ce qui est idéal pour des notes confidentielles.
• Utile pour documenter sans alourdir le rendu : Cette balise est très pratique pour inclure des explications, des rappels ou des instructions dans le code source Liquid, sans que cela n'impacte le HTML généré ou ne soit visible par les utilisateurs finaux ou les outils d'inspection du navigateur.
• Aucune prise en charge de paramètres : La balise comment n'accepte aucun paramètre. Elle fonctionne uniquement comme un délimiteur autour d'un bloc de texte à ignorer. Cela la rend simple à utiliser, mais aussi limitée en termes de personnalisation.
• Peut masquer du code temporairement : Elle est souvent utilisée pour masquer du code Liquid ou HTML temporairement, par exemple durant des tests ou des modifications. Cela permet de désactiver rapidement une section sans la supprimer, ce qui est utile en phase de développement ou de débogage.
• Différente des commentaires en ligne HTML : Alors que les commentaires HTML sont visibles dans l'inspecteur du navigateur, les commentaires Liquid sont traités côté serveur. Ils sont donc totalement absents du code rendu. C'est particulièrement utile pour cacher des informations techniques sensibles aux yeux de l'utilisateur final.
• Compatibilité avec d'autres balises à l'intérieur : On peut placer n'importe quel contenu Liquid à l'intérieur d'un bloc comment, y compris des balises comme if, assign ou for. Toutefois, ce contenu ne sera ni interprété ni évalué : il sera complètement ignoré, comme s'il n'existait pas.
• Pas d'effet sur la performance de rendu : Étant donné que le moteur Liquid ignore entièrement le contenu des balises comment, celui-ci n'affecte pas le temps d'exécution ni le rendu final de la page. Cela en fait un excellent outil pour ajouter de la documentation sans coût en performance.
• Bonne pratique pour la maintenance du code : L'utilisation des commentaires est une bonne habitude dans tout projet de développement. En Liquid, la balise comment permet de garder des traces claires de l'intention du code, d'indiquer des TODO ou de laisser des notes aux autres développeurs travaillant sur la même page.