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 :

Initiation à Doxygen pour C et C++ [Tutoriel]


Sujet :

C

  1. #1
    Rédacteur
    Avatar de Franck.H
    Homme Profil pro
    Développeur .NET
    Inscrit en
    janvier 2004
    Messages
    6 951
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 44
    Localisation : France, Haut Rhin (Alsace)

    Informations professionnelles :
    Activité : Développeur .NET
    Secteur : Service public

    Informations forums :
    Inscription : janvier 2004
    Messages : 6 951
    Points : 12 449
    Points
    12 449
    Par défaut Initiation à Doxygen pour C et C++
    http://franckh.developpez.com/tutoriels/outils/doxygen/

    Vous désirez créer de la documentation technique pour vos projets de développement ? Ce tutoriel va vous montrer la marche à suivre pour arriver à vos fins avec Doxygen !
    Vous pouvez laisser un commentaire pour cet article à la suite.


    Mon Site
    Ma bibliothèque de gestion des chaînes de caractères en C

    L'imagination est plus importante que le savoir. A. Einstein

    Je ne répond à aucune question technique par MP, merci d'avance !

  2. #2
    Expert éminent sénior
    Avatar de Luc Hermitte
    Homme Profil pro
    Développeur informatique
    Inscrit en
    août 2003
    Messages
    5 273
    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 273
    Points : 10 827
    Points
    10 827
    Par défaut
    Hum ... J'avais réagis sur le blog, mais le lien (depuis l'article) ne semble plus valable.

    Pour trace, en substance j'avais signalé que,
    - sont abordé des tags qui en pratique sont superflus car implicites (et que je n'utilise donc jamais) (\fn, \class, \struct, \namespace, ...). Les tags de formatage me servent bien plus -> %, \c, <em></em>, tirets pour les listes, ...

    - manque la famille de tags qui rendent une doc consultable -> \ingroup, \defgroup, etc (je trouve l'immense majorité des docs doxygen/javadoc sont en write-only, toutes les classes étant mises à plat (ou par arbre d'héritage, ce qui ne change rien) sans la moindre organisation ou explication de comment les choses s'utilisent. Définir des groupes permet de mettre un peu de structure aux services proposés et de rajouter des docs chapeau qui parlent de principe et d'intégration)
    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...

  3. #3
    Rédacteur
    Avatar de 3DArchi
    Profil pro
    Inscrit en
    juin 2008
    Messages
    7 634
    Détails du profil
    Informations personnelles :
    Localisation : France

    Informations forums :
    Inscription : juin 2008
    Messages : 7 634
    Points : 13 008
    Points
    13 008
    Par défaut
    Bonjour,
    J'aime bien le tutoriel.
    Quelques (petites) remarques :
    Je partage l'avis de Luc Hermitte sur les groupes qui permettent de mieux structurer la doc de 'gros' projet.
    En C++, j'utilise beaucoup les balises pre, post et invariant aussi.
    Quand à docwizard, j'ai récemment mis à jour (sous windows) et la nouvelle version est un peu plus agréable.

  4. #4
    Expert éminent sénior
    Avatar de Luc Hermitte
    Homme Profil pro
    Développeur informatique
    Inscrit en
    août 2003
    Messages
    5 273
    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 273
    Points : 10 827
    Points
    10 827
    Par défaut
    Oui! Tout ce qui concerne la PpC, j'en use et abuse aussi.

    PS: (je cherchais une autre info quand je suis tombé sur ce post, je suis donc allé un peu vite). Bien aussi. Surtout la partie environnement avec doxywizard qui est probablement ce qu'il y a de plus rédibitoire au départ.
    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...

  5. #5
    Rédacteur
    Avatar de Franck.H
    Homme Profil pro
    Développeur .NET
    Inscrit en
    janvier 2004
    Messages
    6 951
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 44
    Localisation : France, Haut Rhin (Alsace)

    Informations professionnelles :
    Activité : Développeur .NET
    Secteur : Service public

    Informations forums :
    Inscription : janvier 2004
    Messages : 6 951
    Points : 12 449
    Points
    12 449
    Par défaut
    pour vos remarques cela dit, il ne s'agit que d'une initiation pas d'une documentation complète, juste les bonnes bases pour débuter Cela a tout de même permis à ce tutoriel de servir de support de cours dans deux IUT, un au Québec (Université Laval) et l'autre dans l'école polytechnique universitaire de Nice
    Mon Site
    Ma bibliothèque de gestion des chaînes de caractères en C

    L'imagination est plus importante que le savoir. A. Einstein

    Je ne répond à aucune question technique par MP, merci d'avance !

  6. #6
    Malikemal
    Invité(e)
    Par défaut
    Désolé pour le déterrage de topic, mais je tenais à aussi donner mon avis !
    Je trouve qu'il est bien fait, et ça va en effet m'aider pour documenter ma lib, mais je pense aussi qu'un peu plus de profondeur aurait été préférable

  7. #7
    Membre habitué Avatar de dafpp
    Homme Profil pro
    Étudiant
    Inscrit en
    janvier 2008
    Messages
    345
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France

    Informations professionnelles :
    Activité : Étudiant

    Informations forums :
    Inscription : janvier 2008
    Messages : 345
    Points : 196
    Points
    196
    Par défaut
    merci pour ce tuto, il va bien me servir.
    "Les spécialistes commencent par n'apprendre que ce qu'ils aiment et finissent par n'aimer que ce qu'ils ont appris." - Gilbert Cesbron
    "Si nous avons chacun un objet et que nous les echangeons, nous avons chacun un objet. Si nous avons chacun une idée et que nous les échangeons, nous avons chacun deux idées." - Proverbe Chinois.

Discussions similaires

  1. Doxygen pour PHP, génération de documents comment faire?
    Par Mika2008 dans le forum EDI, CMS, Outils, Scripts et API
    Réponses: 3
    Dernier message: 23/06/2009, 22h34
  2. initiation vba pour photo
    Par lolo123 dans le forum VBA Access
    Réponses: 1
    Dernier message: 25/12/2007, 22h11
  3. Réponses: 16
    Dernier message: 23/06/2007, 11h58
  4. [XML] Initiation xml pour très nul
    Par pappy dans le forum XML/XSL et SOAP
    Réponses: 1
    Dernier message: 16/10/2006, 19h15

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