PDF download Télécharger l'article PDF download Télécharger l'article

Commenter votre code vous permet de laisser des rappels et des explications pour vous-même et pour tout autre codeur qui travaillera sur la page. Commenter peut également être utilisé pour désactiver rapidement certaines parties de votre code lorsque vous êtes en train de faire un test ou de travailler sur une nouvelle fonctionnalité qui n'est pas encore prête. Apprendre comment utiliser correctement les commentaires vous conduira, vous et vos collègues, à écrire du code plus efficacement.

  1. Les commentaires sont désignés par les balises <! -- et --> . Vous pouvez rapidement insérer des commentaires pour vous rappeler ce qui se passe dans le code.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    Test de commentaire </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     <!--Ce code forme un paragraphe --> 
     < 
     p 
     > 
    Voici le site web </ 
     p 
     > 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
    • Assurez-vous qu’il n’y a pas d’espace à l’intérieur de la balise de commentaire. Par exemple, < !-- n’activera pas la fonction de commentaire. À l’intérieur des balises, vous pouvez mettre autant d’espaces que vous voulez.
  2. Vos commentaires peuvent s'étendre sur plusieurs lignes, ce qui est utile pour expliquer du code complexe, ou pour isoler de grandes parties de code.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    Test de commentaire </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     <!-- 
     Votre commentaire peut être aussi longtemps que vous le souhaitez. 
     Tout ce qui est à l'intérieur des balises de commentaire ne va pas 
     affecter le code de la page. 
     --> 
     < 
     p 
     > 
    Voici le site web </ 
     p 
     > 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
  3. Si vous essayez de trouver un bug ou si vous voulez empêcher que du code s’exécute sur la page, vous pouvez utiliser la fonction commentaire pour le bloquer rapidement. Ainsi, vous pouvez facilement restaurer le code en supprimant la balise de commentaire.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    Test de commentaire </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     < 
     p 
     > 
    Regardez ces images </ 
     p 
     > 
     < 
     img 
     src 
     = 
     "/images/image1.jpg" 
     > 
     <!--Pour l’instant, cette image ne s’affiche pas 
     <img src="/images/image2.jpg"> 
     --> 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
  4. Si vous êtes en train de programmer en JavaScript ou en VBScript, vous pouvez utiliser la fonction commentaire pour cacher le script sur les navigateurs qui ne le prennent pas en charge. Insérez le commentaire au début du script, et terminez-le avec //--> pour vous assurer que le script fonctionne sur les navigateurs qui le prennent en charge réellement.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    VBScript </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     < 
     script 
     language 
     = 
     "vbscript" 
     type 
     = 
     "text/vbscript" 
     > 
     <!-- 
     document 
     . 
     write 
     ( 
     "Hello World!" 
     ) 
     //--> 
     </ 
     script 
     > 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
    [1]
    • Le symbole // dans la balise de fin va empêcher le script d’exécuter la fonction de commentaire si les scripts sont pris en charge par le navigateur.
    Publicité

Conseils

  • Commentez régulièrement, car il vous sera beaucoup plus facile de revenir sur votre code plus tard et de vous rappeler comment tout fonctionne.
Publicité

À propos de ce wikiHow

Cette page a été consultée 43 950 fois.

Cet article vous a-t-il été utile ?

Publicité