CSSdoc

Bonjour, l'ouvrage que j'ai sous la main (et qui date d'il y a trois ans) me parle de CSSdoc.

Pour résumer, il y est dit que la rédaction des commentaires peut suivre la convention CSSdoc. Elle définit la façon dont les blocs de documentation (DocBlock) peuvent être rédigés. Ce type de conventionnement est utilisé dans d'autres langages (Java, PHP, JavaScript) et assure à la feuille de styles une certaine uniformité. S'en suit un listing de différents tags (@site, @media,...).

Un exemple:

/**   Support incomplet de display: inline-block;
 *  @bugfix  
 *  @affected     IE6, IE7
 *  @see	           http://www.blablabla  */

J'ai tenté de retrouver la liste complète des tags sur le site renseigné, mais ce dernier est mort... (www.cssdoc.net).

Pourriez-vous me donner votre avis sur ce conventionnement et, si vous disposez d'un listing complet des tags, me transmettre la pièce jointe/l'url ?

Cordialement,

Bonjour !

En utilisant la wayback machine (archive.org) tu peux retrouver le site : voici la page de téléchargement du pdf complet. La dernière version u pdf remonte à 2008.

Personnellement je l’utilise quotidiennement, mais avec une palette de tag assez restreinte :
- @note
- @bugfix
- @affected
- @see
- @author

La plupart du temps, cela répond à mes besoins

Bonjour et bienvenue,

merci à toi Ten pour cette recherche
Utile voire indispensable au moins en entête de chaque feuille de style. J'évite les commentaires de plus d'une voire 2 lignes quand ce sont des bugfix mais c'est aussi parce qu'en utilisant un gestionnaire de bug (trac et autres redmine), s'il y a besoin de détails en général il y a une référence vers cet outil...

Effectivement !

J’en ai oublié deux que j’utilise de façon récurrente : @todo et @IE8 (oui, je raccourci le @affected IE8) qui me servent presque d’ancres lorsque je repars en chasse

Et je me sers très souvent aussi de @section et @subsection pour structurer mes fichiers (cf un de mes fichiers de base).

Jßespère que ça aide

Un grand merci, je ne connaissais pas la wayback machine