Je me demandais récemment à quel niveau il est possible de placer un commentaire HTML le plus tôt possible dans mon code.
<!-- ici ? (1) -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<!-- ici ? (2) -->
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<!-- ici ? (3) -->
<head>
<!-- ici ? (4) -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title></title>
</head>
<!-- ici ? (5) -->
<body>
<!-- ici ? (6) -->
</body>
</html>
Il me semble que le DOCTYPE doit être placé en 1er, j’opte donc pour la solution 2, mais à vous de m’éclairer si besoin.
Par ailleurs, j’aurais aimé connaitre un peu vos habitudes de travail avec les commentaires.
- Produisez-vous une documentation supplémentaire accompagnant votre projet pour ne pas surcharger votre HTML ?
- Que mettez-vous alors dans le code HTML ?
- Indiquez-vous par exemple les fermetures de conteneurs, des commentaires à destination des développeurs, votre nom ou encore les astuces de montage ?
8 commentaires ↓
Hello,
J’utilise les commentaires dans 2 cas - Les commentaires conditionnels pour cibler IE (notamment pour les css, éventuellement pour du marquage html mais c’est plus rare) - Pour marquer la fin des grands blocs conteneurs
Pour les astuces de montages c’est généralement dans la feuille de style.
Je sais que marquer la fin des blocs conteneurs c’est un petit truc qui plait bien aux développeurs de ma boîte pour se repérer dans le code^^
Si le code est bien indenté (2 espaces par exemple), les commentaires de fermeture de conteneur ne sont pas utiles.
Je me rends compte que je mets très peu de commentaires dans mon code HTML (en tout cas en HTML visible par le visiteur), je préfère les mettre avec le langage de templates utilisé et c’est généralement pour préciser des détails algorithmiques.
La spec HTML est un peu floue : http://www.la-grange.net/w3c/html4.01/intro/sgmltut.html#h-3.2.4
Par contre, le validateur HTML du W3C valide la syntaxe dans chaque câs.
La spec XML 1.1 est un peu plus clair : http://www.yoyodesign.org/doc/w3c/xml11/#sec-comments
Mais en pratique évitez les commentaires et tout autre type de caractère (même un espace) avant le Doctype si vous développez des documents et/ou applications cross-browser, ça aura comme effet de faire passer IE 6 en quirks mode http://www.quirksmode.org/css/quirksmode.html
A part les commentaires conditionnels que j’utilise pour éviter d’utiliser des hacks pour Internet Explorer, je n’utilise aucun autre commentaire html.
Je fais en sorte de donner des noms d’id et de classe clairement compréhensibles et une bonne indentation du code fait le reste.
Effectivement comme le rappelle Yves, le fait de placer un commentaire html ou un prologue xml avant le doctype a pour effet de faire passer IE6 en mode quirks.
L’idéal pour ne pas surcharger le code html serait de faire une version commentée pour le client et un script qui lui permettrait de supprimer tous les commentaires pour les fichiers à mettre en ligne.
Il est bien ce blog, mais y a pas beaucoup de mises à jour !
Les seuls commentaires que je mets dans le HTML sont des indications de fermeture de blocs (pas si faciles à suivre avec des inclusions, etc) et éventuellement des indications à l’intégrateur dans le genre « attention ici à bien changer le ALT de l’image en fonction du contexte (supprimer ce commentaire après intégration) ». Donc la question de « le plus haut possible » ne m’a jamais même effleuré. Dans quel contexte tu as besoin de mettre un commentaire le plus haut possible ?
Le reste je le mets dans une doc dans le genre .README quelque part dans les fichiers de conf. J’en tire deux avantages :
PS : au pire quand je sais dans quelle techno le travail sera fait, je mets les commentaires dans le langage serveur (par exemple en PHP
<?php /* bla */ ?>)STPo : alors que je viens de poster un nouveau billet ! Voyons…
Stéphane : je cherche à placer une entête générique de fichier comme cela se fait plus couramment en CSS par exemple.
Bonjour, Je me permet de m’inviter sur votre discussion. Je recherche comment créer un commentaire, une annotation, destiné au visiteur de mon site qui passerait sa souris sur un mot auquel je destine ce complément d’information Je vous remercie de votre réponse Trés cordialement Robert
Laisser un commentaire