IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Autres éditeurs Discussion :

Doxygen et variables


Sujet :

Autres éditeurs

  1. #1
    Membre émérite
    Inscrit en
    Janvier 2005
    Messages
    711
    Détails du profil
    Informations forums :
    Inscription : Janvier 2005
    Messages : 711
    Par défaut Doxygen et variables
    Bonjour,
    j'essaie de me mettre a Doxygen pour documenter mon code. Le resultat est nickel, mais il y a un truc qui m'echappe, c'est qu'apparemment il ne permet pas de documenter des variables qui ne sont pas membres d'une classe. Si on prend l'exemple de mon fichier main.cpp :

    j'ai des variables globales declarées en debut de fichier, avec une description derriere (en anglais s'il vous plait :-) )
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
     
    float precision;		/**<precision of the resultat*/
    float incertitude;		/**<accuracy of the data, in %. if it's <0, the accuracy is read in the data file*/
    int nbData;			/**<number of data in the data file*/
    et idem a l'interieur de ma fonction main.

    Or, les variables globales sont listées dans la doc, mais la description saute
    les variables interieure a la fonction main disparaisse. pourtant, doxygen reconnait bien ces descriptions, puisque dans la page qu'il genere qui contient le code coloré, ces descriptions n'apparaissent pas (au meme tire que tout ce qui concerne Doxygen).

    toutes les docs que je trouve ne parle que des classes, des fonctions et de leur parametres, pas des autres variables.. pourtant, il me semble tout aussi important d'expliquer ce qu'elles sont !!

    si quelqu'un a une idée, il aura tout ma gratitude.

  2. #2
    Membre émérite
    Inscrit en
    Janvier 2005
    Messages
    711
    Détails du profil
    Informations forums :
    Inscription : Janvier 2005
    Messages : 711
    Par défaut
    bon, je rectifie : ca marche pour les variables globales. par contre, pour les variable internes, ca ne marche toujours pas. et precisement, (ce qui somme toute est logique) il ajoute la doc de ces variables a la doc de la fonction. je m'explique : si j'ai

    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    6
    7
    8
     
    /**
    Une chouette fonction
    */
    int main()
    {
       float variable;   /**<une chouette variable*/
    ...
    Vous noterez la presence du '<' qui est censé dire que le commentaire se rapporte a la variable a gauche...

    Or la, dans la doc, je n'ai pas de description de ma variable, par contre dans la description de ma fonction j'ai :

    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
     
    int main()
    une chouette fonction
     
    <une chouette variable

    donc il me fout ca dans la oc de la fontion sans tenir compte du '<'. j'en deduis que c'est son comportement normal (il a bien lu le commentaire, et il a fait ca), donc j voulais savoir si je pouvais changer ce comportement..

  3. #3
    Expert éminent
    Avatar de koala01
    Homme Profil pro
    aucun
    Inscrit en
    Octobre 2004
    Messages
    11 644
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 53
    Localisation : Belgique

    Informations professionnelles :
    Activité : aucun

    Informations forums :
    Inscription : Octobre 2004
    Messages : 11 644
    Par défaut
    Salut,

    A vrai dire, il y a deux possibilité de renseignements...

    L'une est fournie par brief et l'autre, par rien...

    je suis pris d'un doute, mais, le fait d'écrire, par exemple
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
     
    /**
    Une chouette fonction
    */
    int main()
    {
       float variable;   /**< \brief une chouette variable
                          *
                          */
    ...
    ne résoudrait-il pas les choses?
    A méditer: La solution la plus simple est toujours la moins compliquée
    Ce qui se conçoit bien s'énonce clairement, et les mots pour le dire vous viennent aisément. Nicolas Boileau
    Compiler Gcc sous windows avec MinGW
    Coder efficacement en C++ : dans les bacs le 17 février 2014
    mon tout nouveau blog

  4. #4
    Membre émérite
    Inscrit en
    Janvier 2005
    Messages
    711
    Détails du profil
    Informations forums :
    Inscription : Janvier 2005
    Messages : 711
    Par défaut
    Non, ca ne change rien.. et la doc de doxygen semble indiquer qu'on ne peut as mettre ce genre de commentaire dans le corps d'une fonction.. je trouve ca curieux !! et pas tres pratique...

  5. #5
    Membre chevronné
    Profil pro
    Inscrit en
    Juillet 2006
    Messages
    258
    Détails du profil
    Informations personnelles :
    Âge : 46
    Localisation : France, Bas Rhin (Alsace)

    Informations forums :
    Inscription : Juillet 2006
    Messages : 258
    Par défaut
    J'utilise Doxygen depuis un bout de temps, et ce genre d'utilisation ne m'est jamais venu à l'esprit : j'ai toujours utilisé des commentaires "normaux" pour les détails d'implémentation, et Doxygen pour tout le reste. Bien que ça ne soit écrit nulle part noir sur blanc, Doxygen est plutôt réservé à l'interface, et non pas à la cuisine interne des classes et des fonctions.

  6. #6
    Membre émérite
    Inscrit en
    Janvier 2005
    Messages
    711
    Détails du profil
    Informations forums :
    Inscription : Janvier 2005
    Messages : 711
    Par défaut
    c'est a peu pres la conclusion a laquelle j'etais arrivé. Mais je redige cette doc essentiellement pour que quelqu'un puisse reprendre le code facilement derriere moi, quelqu'un qui ne serait pas forcement un "pro" (je ne le suis pas moi meme, je suis plutot mathematicien..) meme si j'essaie de faire gaffe, j'ai surement des lacunes dans la presentation et l'organisation du code, et une doc claire ne serait pas du luxe. Mais je vais me contenter de commentaire "normaux"...

    merci !

  7. #7
    Expert confirmé
    Avatar de Luc Hermitte
    Homme Profil pro
    Développeur informatique
    Inscrit en
    Août 2003
    Messages
    5 296
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France, Haute Garonne (Midi Pyrénées)

    Informations professionnelles :
    Activité : Développeur informatique
    Secteur : Aéronautique - Marine - Espace - Armement

    Informations forums :
    Inscription : Août 2003
    Messages : 5 296
    Par défaut
    La doc doxygen, c'est essentiellement pour les utilisateurs des bibliothèques.
    La tambouille interne, ben c'est interne, et dans le code.
    Blog|FAQ C++|FAQ fclc++|FAQ Comeau|FAQ C++lite|FAQ BS|Bons livres sur le C++
    Les MP ne sont pas une hotline. Je ne réponds à aucune question technique par le biais de ce média. Et de toutes façons, ma BAL sur dvpz est pleine...

Discussions similaires

  1. Documentation de variable sous doxygen
    Par black_hole dans le forum Autres éditeurs
    Réponses: 3
    Dernier message: 21/08/2014, 11h20
  2. Réponses: 2
    Dernier message: 14/05/2014, 14h16
  3. Doxygen - Documentation des variables (C++)
    Par jOJo73450 dans le forum C++
    Réponses: 10
    Dernier message: 02/07/2012, 21h19
  4. Réponses: 4
    Dernier message: 05/06/2002, 14h35
  5. les variables globales static
    Par gRRosminet dans le forum C
    Réponses: 8
    Dernier message: 27/04/2002, 08h34

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo