Invité
|
Posté le: Jeu Jan 01, 1970 16:44 Sujet du message: |
|
|
non il ne s'agit pas d'include, mais des commandes @file @func @...
ou tu donne le nom du fichier que tu documente pour @file
le prototype de ta fonction pour @func
le prototype de ta classe pour @class,
...
C'est efectivement un peu plus lourd à écrire, car tu dois réécrire le
prototype de ce que tu comment, mais faut dire je vois pas comment Doxygen pourait deviner de quoi tu parle si tu le lui dit pas.
Dans le cas où c'est dans le code, il le sait car c'est la la chose qui suit immédiatement le commentaire qui est visée.
A ce propos, faites attention lorsque vous mett(r)ez des commentaire sur la même ligne qu'une instruction (enfin si vous vous autorisez à faire une telle chose ), le commentaire dans ce cas cible l'instruction suivante par defaut. Il est possible de lui dire que c'est l'instruction précédante la cible, mais je vous laisse regardr la doc pour ça.
Personnellement j'ai l'habitude d'indenter comme suit:
méthode courte:
int
methode1 ( int a, int b)
{
}
méthode longue:
int
methode_tres_tres_longue ( type_utilisateur1 variable1,
type_utilisateur2 variable2)
{
}
mais bon vous faite comme vous voulez, d'autant plus que je ne fait pas
parti de l'équipe de dévellopement, mais comme j'aime bien mettre mon grain de sel partout...
PS: les espaces ne passent pas, mais vous aurez compris que type_utilisateur2 est aligné sous type_utilisateur1... |
|