Encore une question de doc : @group et @end

Hello,

Encore une question de documentation.

La question ne concerne pas directement le CSS ou le PDF ou le HTML, mais comme j'ai vu cette chose apparaitre dans un source CSS, pourquoi pas la posté ici aussi. Depuis 3 jours, je n'ai de toute manière pas réussi à trouver une réponse (enfin, sans y avoir passé trois jours à proprement parler).

Voilà : Doxygen, permet d'utiliser des templates, et on peut lui demander de générer ses templates par défaut. C'est à ce moment que j'ai trouvé, dans le fichier CSS qu'il a généré, des notations "@group" et "@end". Je vous poste un extrait du CSS :

/* The standard CSS for doxygen */

body, table, div, p, dl {
    font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
    font-size: 12px;
}

/* @group Heading Levels */

h1 {
    font-size: 150%;
}

h2 {
    font-size: 120%;
}

h3 {
    font-size: 100%;
}

dt {
    font-weight: bold;
}

div.multicol {
    -moz-column-gap: 1em;
    -webkit-column-gap: 1em;
    -moz-column-count: 3;
    -webkit-column-count: 3;
}

p.startli, p.startdd, p.starttd {
    margin-top: 2px;
}

p.endli {
    margin-bottom: 0px;
}

p.enddd {
    margin-bottom: 4px;
}

p.endtd {
    margin-bottom: 2px;
}

/* @end */

caption {
    font-weight: bold;
}

Est-ce que ça parle à quelqu'un ?

Si je devine bien ce que signifient ces deux annotations, alors elles m'intéressent beaucoup, mais j'ai besoin de savoir si je peux me reposer dessus, et pour cela, j'ai besoin d'en connaitre la source, et surtout de savoir si oui ou non c'est standard.

J'ai d'abord pensé à une notation à la JavaDoc, qui est utilisé partout, et pas seulement pour Java (on en voit même dans le JavaScript, ce qui est plutôt une bonne chose que ça se répande), mais je n'ai pas trouvé trace de ces annotations dans le standard JavaDoc, et puis les recherche sur le web avec des mots clés comme "group" et "end", ça ne va pas bien loin.

Bonjour,

Je ne sais pas si cette notation fait office d'une quelconque convention ou autres.

En revanche, je peux t'indiquer que CSSEdit (qui est un excellent éditeur CSS disponible sous Mac soit dit en passant) en fait usage afin de pouvoir gérer les différents déclarations de la feuille.

Ainsi cet éditeur permet au concepteur d'avoir, dans une fenêtre d'explorateur, la représentation de la feuille sous forme d'arborescence (/* @group Nom du groupe */ et /* @end */ permettent de désigner une zone - un dossier "Nom du groupe" regroupant des déclarations).

Je ne sais pas si il existe d'autres outils qui en font usage ... en tout cas, je trouve ce mécanisme très intéressant.

Romain

yodaswii a écrit :
Bonjour,

Je ne sais pas si cette notation fait office d'une quelconque convention ou autres.

En revanche, je peux t'indiquer que CSSEdit (qui est un excellent éditeur CSS disponible sous Mac soit dit en passant) en fait usage afin de pouvoir gérer les différents déclarations de la feuille.

Yoda Romain, t'es un vrai Jedi

Alors ça vient de CSSEdit, que je ne connaissais pas. Ça explique donc pourquoi je n'avais jamais vu ça avant, et pourquoi ça apparait en particulier dans du CSS.

yodaswii a écrit :
Ainsi cet éditeur permet au concepteur d'avoir, dans une fenêtre d'explorateur, la représentation de la feuille sous forme d'arborescence (/* @group Nom du groupe */ et /* @end */ permettent de désigner une zone - un dossier "Nom du groupe" regroupant des déclarations).

Oui, c'est bien comme ça que je le comprennais.

yodaswii a écrit :
Je ne sais pas si il existe d'autres outils qui en font usage ... en tout cas, je trouve ce mécanisme très intéressant.

Ben Oui! Justement! C'est que ça m'intéresse aussi. J'utilise un éditeur qui fait une sorte de outlining, qui n'est malheureusement pas standard, et qui repose sur du balisage, j'ai aussi utilisé ce qu'on appelle la Programmation Littéral, qui repose aussi sur ce type de balisage, ce sont des choses intéressantes, pour pouvoir organiser ce qui est complexe et le rendre plus lisible; mais comme tout ce qui est inhabituel, ça n'est pas accepté, et je cherche donc un balisage des commentaires permettant la même chose, mais paraissant plus acceptable, parce qu'ayant l'air de quelque chose de déjà vu.

Je vais donc voir du côté de CSSEdit, et voir si son balisage a été repris d'autres choses de déjà existant et voir si c'est connu et s'il existe une communauté dans laquelle cette notation est suffisamment reconnue.

hibou57 a écrit :
savoir si oui ou non c'est standard

Ce sont des commentaires. Tu écris ce que tu veux dans un commentaire.
Donc:
- La syntaxe de commentaire est <del>casher</del> standard.
- Le contenu du commentaire peut éventuellement être parsé et utilisé par un éditeur, une lib de génération de documentation, un système de build ou de template, un générateur de truc ou un machineur de bidule. La piste CSSEdit semble bonne ici.