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

C++ Discussion :

Make docs, how to?


Sujet :

C++

  1. #1
    Membre du Club Avatar de bahaaldine
    Profil pro
    Inscrit en
    Octobre 2006
    Messages
    67
    Détails du profil
    Informations personnelles :
    Âge : 39
    Localisation : France

    Informations forums :
    Inscription : Octobre 2006
    Messages : 67
    Points : 45
    Points
    45
    Par défaut Make docs, how to?
    Salut à tous !

    J'ai en fait une question sur une manipulation que je ne connais pas.
    Il met arriver de continuer le programme d'autres personnes, des programmes fait en c++.
    Il y avait une manipulation très pratique à faire pour obtenir de la documentation sur ce qui a déjà était fait, je tapais une ligne du type :
    make docs
    et cela me générer une page html qui contenait tous les commentaires présents dans les fichiers sources.
    Mais apparament il y a une manière d'écrire ces commentaires, manière que je ne connais pas.
    Pouvez vous m'éclaircir sur ce point.
    Merci @ TOouS

  2. #2
    Membre éclairé
    Homme Profil pro
    Consultant ERP
    Inscrit en
    Février 2004
    Messages
    644
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : Belgique

    Informations professionnelles :
    Activité : Consultant ERP

    Informations forums :
    Inscription : Février 2004
    Messages : 644
    Points : 785
    Points
    785
    Par défaut
    non, il faudrait que l'on ait une idée de la manière dont ton code est commenté documenté, etc...
    Nul ne peut mieux connaitre la connaissance qu'elle-même.

  3. #3
    Expert éminent

    Inscrit en
    Novembre 2005
    Messages
    5 145
    Détails du profil
    Informations forums :
    Inscription : Novembre 2005
    Messages : 5 145
    Points : 6 911
    Points
    6 911
    Par défaut
    Cherche doxygen
    Les MP ne sont pas là pour les questions techniques, les forums sont là pour ça.

  4. #4
    Membre du Club Avatar de bahaaldine
    Profil pro
    Inscrit en
    Octobre 2006
    Messages
    67
    Détails du profil
    Informations personnelles :
    Âge : 39
    Localisation : France

    Informations forums :
    Inscription : Octobre 2006
    Messages : 67
    Points : 45
    Points
    45
    Par défaut exemple
    Voici un exemple



    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
     
     
    /***************************************************************************
     *   Copyright (C) 2004 by Fabien Rico                                     *
     *   fabien.rico@lip6.fr                                                   *
     *                                                                         *
     *   This program is free software; you can redistribute it and/or modify  *
     *   it under the terms of the GNU General Public License as published by  *
     *   the Free Software Foundation; either version 2 of the License, or     *
     *   (at your option) any later version.                                   *
     *                                                                         *
     *   This program is distributed in the hope that it will be useful,       *
     *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
     *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
     *   GNU General Public License for more details.                          *
     *                                                                         *
     *   You should have received a copy of the GNU General Public License     *
     *   along with this program; if not, write to the                         *
     *   Free Software Foundation, Inc.,                                       *
     *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
     ***************************************************************************/
    #ifndef CFOURMI_H
    #define CFOURMI_H
     
     
    extern "C"
     
    class cMonde;
     
    /**
    Classe de base des fourmis avec un déplacement minimal, le dépot et le ramassage des oeufs
     
    @author Fabien Rico
    */
    class cFourmi{
     
    public:
      /**
        \fn cFourmi::cFourmi()
        \brief le constructeur d'une fourmi
        
        ce constructeur place aléatoirement la fourmi dans le monde
        il ne se soucie pas de placer plusieurs fourmis au même endroit.
      */
        cFourmi();
     
        /**
           @brief Destructeur
         */
        virtual ~cFourmi();
     
        // Les accesseurs
        /*!
          \fn cFourmi::Etat_bouche() const
          \result le contenu de la bouche RIEN, OEUF_BLEU ou OEUF_ROUGE
        */
        int Etat_bouche() const;
     
        /**
           @brief Pour modifier la variable de classe le_monde
     
           Cette fonction (statique) permet de fixer la valeur
           de la variable commune à toutes les fourmis : le_monde.
           Cette variable leur permet d'accéder au information sur
           tableau dans lequel elles se trouvent.
         */
        static void set_monde(cMonde *m);
     
        /*!
          \fn cFourmi::get_posX() const
          \result l'abscisse de la fourmi
        */
        unsigned get_posX() const;
        /*!
          \fn cFourmi::get_posY() const
          \result l'ordonnée de la fourmi
        */
        unsigned get_posY() const;
     
        // Les méthode utilitaires
        /**
           \fn cFourmi::bouge()
           \brief pour faire bouger la fourmi
           le monde est considéré circulaire
        */
         virtual void bouge();
     
        /*!
          \fn cFourmi::decide()
          \brief C'est la fonction de base de la classe
          
          La fourmi doit décider de prendre un oeuf si elle n'en as pas déjà
          un ou dans le cas contraire de le poser.
          Pour cela, on se sert des fonctions compte_oeuf_ident et
          compte_oeuf_diff pour calculer la proportion d'oeuf.
        */
        void decide();
     
        /**
           \param oeuf : un type d'oeuf
           \brief compte les oeufs de meme type que celui
           passé en paramètre
           \todo Cette fonction est incomplète
         */
        virtual int compte_oeuf_ident(int oeuf) const = 0  ;
     
        /**
           \param oeuf : un type d'oeuf
           \brief compte les oeufs de type différent de celui
           passé en paramètre
           \todo Cette fonction est incomplète       
         */
        virtual int compte_oeuf_diff(int oeuf) const = 0;
     
    protected:
     
     
        /*!
          \fn cFourmi::prend_oeuf()
          \brief la fourmi prend un oeuf là où elle est
     
          Attention, pour être correctement utilisé, il faut que la fourmi
          ne porte pas d'oeuf et soit sur une case comportant un oeuf.
        */
        void prend_oeuf();
     
        /*!
          \fn cFourmi::pose_oeuf()
          \brief la fourmi pose l'oeuf là où elle est.
        */
        void pose_oeuf();
     
        /**
        Un pointeur sur le monde dans lequel sont les fourmis c'est une
        variable de classe (car toutes les fourmis sont dans le même
        monde).
        */
        static cMonde *le_monde;
     
        /**
           L'abscisse de la fourmi dans le monde
        */
        int posX;
        /**
           L'ordonnée de la fourmi dans le monde
        */
        int posY;
        /**
        L'état de la bouche (RIEN, OEUF_BLEU ou OEUF_ROUGE)
        */
        int bouche;
     
    };
     
     
    #endif

  5. #5
    Expert éminent sénior
    Avatar de koala01
    Homme Profil pro
    aucun
    Inscrit en
    Octobre 2004
    Messages
    11 614
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 52
    Localisation : Belgique

    Informations professionnelles :
    Activité : aucun

    Informations forums :
    Inscription : Octobre 2004
    Messages : 11 614
    Points : 30 626
    Points
    30 626
    Par défaut
    Salut,

    Ce genre de commentaire est, typiquement, du genre de celui utilisé avec doxygen ou javadoc...

    Tu trouveras toutes les informations ==>ICI<== en ce qui concerne doxygen (vu que javadoc... ben, ... ce serait pas uniquement prévu pour java???)...

    Dans la documentation, tu trouveras, entre autre, la manière de formater tes commentaires...

    En gros, quelque chose qui doit etre interprété par doxygen doit commencer sous la forme de
    Tu disposes d'un certain nombre de "mot cle" pour signaler ce que tu t'apprete à documenter (fn, brief, param, return, throw et bien d'autre encore) et tu dois les faire précéder d'un \ ou d'un @ pour qu'il soit considérés comme mots clé...

    Il y a une foule de possiblités, donc, le plus facile, c'est encore de t'attaquer à la documentation qui s'y rattache

    Edit:
    Certains EDI (je penses, entre autre a code::blocks) sont en mesure de te représenter les commentaires pris en compte par doxygen différemment des commentaires qui ne seront pas pris en compte par doxygen
    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

  6. #6
    Membre du Club Avatar de bahaaldine
    Profil pro
    Inscrit en
    Octobre 2006
    Messages
    67
    Détails du profil
    Informations personnelles :
    Âge : 39
    Localisation : France

    Informations forums :
    Inscription : Octobre 2006
    Messages : 67
    Points : 45
    Points
    45
    Par défaut
    Merci beaucoup pour ta réponse
    Merci à tous !

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