begin process at 2012 02 05 04:19:03
  Trouver un code source :
 
dans
 
Accueil > 

Code

 > 

Tutoriaux

 > PRÉSENTATION DE DOXYGEN

PRÉSENTATION DE DOXYGEN


 Information sur la source

Note :
8,33 / 10 - par 3 personnes
8,33 / 10

  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10
Catégorie :Tutoriaux Classé sous :doxygen, documentation, windows Niveau :Débutant Date de création :23/11/2005 Date de mise à jour :17/01/2007 19:59:11 Vu / téléchargé :21 729 / 2 713

Auteur : buno

Ecrire un message privé
Ce membre participe au partage de revenus publicitaires
Commentaire sur cette source (17)
Ajouter un commentaire et/ou une note


 Description

Tout développeur qui a été amené à reprendre le programme d'un autre s'est dit: "ah m...! Mais qu'est-ce qu'il a voulu coder? A quoi sert cette fonction!! Comment je fais pour faire ceci?..."

Une solution: Doxygen. C'est un générateur de documentation basé Javadoc qui fonctionne aussi bien pour les codes Java ou C/C++.

Je vous propose ici une petite présentation sur ce qu'est exactement Doxygen mais surtout, comment l'utiliser: depuis son téléchargement jusqu'à la génération de doc.

/!\ Attention!! Ceci est valable uniquement pour Windows.


 Conclusion

Doxygen est GNU GPL. Le site officiel: http://www.stack.nl/~dimitri/doxygen/

Ce document est un premier jet. Dans le cas où beaucoup de développeurs en voudraient plus, je la mettrais à jour.
Merci pour toute remarque qui m'aiderait à rendre ce document comme un support de formation

Disponible au format PPT et PDF

 Fichier Zip

Les Membres Club peuvent télécharger directement un fichier contenu dans le zip sans télécharger le zip en entier !
  • Doxygen.pdfTélécharger ce fichier [Réservé aux membres club]105 487 octets
  • Doxygen.pptTélécharger ce fichier [Réservé aux membres club]185 856 octets

Télécharger le zip


 Historique

25 novembre 2005 09:52:29 :
Prise en compte des remarques de Kirua concernant l'orthographe et le contenu de la balise @code
17 janvier 2007 19:59:11 :
Ajout d'une version au format PDF

 Sources du même auteur

Source avec Zip DÉTECTION DE LANCEMENT D'APPLICATION (WIN32, REGISTERSHELLHO...
RÉCUPÉRATION DE L'URL COURANTE DANS INTERNET EXPLORER
Source avec Zip Source avec une capture IMPLÉMENTATION DE LA GESTION STANDARD DES CHAINES DE CARACTÈ...
SUPPRIMER UNE CHAINE DE CARACTERES D'UN FICHIER
Source avec Zip LOADER BMP + TRAITEMENT

 Sources de la même categorie

LISTER FICHIERS ET RÉPERTOIRES (MULTIPLATEFORME) par christophedlr
UTILISATION DES TYPELIST EN C++ par wyden
Source avec Zip Source avec une capture QCSSCOMPRESSOR par alphaone
AFFICHAGE D'UN TRIANGLE ISOCELE par nabche
Source avec Zip GESTION D'UNE BIBLOTHEQUE par leclerro19

 Sources en rapport avec celle ci

Source avec Zip Source avec une capture POUR AFFICHER LES CARACTÈRES ACCENTUÉS SOUS WINDOWS EN MODE ... par pgl10
Source avec Zip Source avec une capture SOKOBAN EN C POUR DÉBUTANT (VERSION AMÉLIORÉE BASÉE SUR LE T... par eustatika
Source avec Zip [MYLIB] GESTION DE FICHIERS par Galaad2908
Source avec Zip PROTECTION AU DÉMARAGE DE WINDOWS ET PENDANT par daminator2
Source avec Zip MODIFIER RAPIDEMENT SON FICHIER HOST par sholvaC

Commentaires et avis

Commentaire de mindslight le 24/11/2005 08:32:23

c'est sympa doxygen.
la doc est riche et en plus c'est multiplateforme.

si tu a le temps faire un tour vers ma source que,
j'ai déposée hier "body of the knowledge".
c'est un logiciel de documentation dont le but est de,
partager les library avec d'autre devellopeur.

a+

Commentaire de Kirua le 24/11/2005 10:39:29

j'ai bien aimé ce document. j'avais déjà utilisé doxyen mais jamais les commentaires du style javadoc. juste deux remarques:

- faute d'ortho sur le transparent "balises 2":
"On peut également précisé si le paramètre est entrant et/ou sortant : [in], [out] ou [in,out]"
c'est "préciser". si tu cherches à le présenter en public, faut faire gaffe ;)

- sur le même transparent, tu as un exemple de code, avec un commentaire /* */ dedans, et je comprends pas pq le */ n'est pas interprêté comme la fin du bloc de "doxy doc". Tu sais expliquer ça?

Sinon, c'est chouette. Je pense que même si personne ne le lire, ce serait bien d'introduire, au moins en annexe, une liste exhaustive des balises, même sans explication, car ça se comprend aisément et pr les gens qui téléchargeront ton cours, ce sera bien agréable.

voilà ;)

Commentaire de buno le 24/11/2005 11:43:19 administrateur CS

Merci de ta réactivité Kirua (et surtout de la détection de la faute d'ortho :°)

En réponse à ta question, Doxygen n'interprête pas le texte qui est inclus entre les balises @code/@endcode. Tu peux donc y placer des commentaires classiques.

Concernant la liste des balises, j'ai voulu citer les plus utiles dans un premier temps. Ensuite, effectivement, je rajouterais les balises permettant d'influencer la présentation finale

Commentaire de Kirua le 24/11/2005 23:24:02

Ok pour doxygen, mais le compilateur C++ il ne va pas comprendre qu'il ne doit pas interprêter le */, enfin, ça me paraît impossible à vrai dire.

Commentaire de buno le 25/11/2005 09:41:23 administrateur CS

Oups...pardon! Copier-Coller malencontreux :(

Effectivement, tu as raison, le compilo C++ perd les pédales. Voici ce qu'il faut faire:
Dans le bloc de commentaires:
@code
// voici un commentaire
void fonction(...)
@endcode

Ensuite, Doxygen l'interprête comme suit:
/* voici un commentaire */
void fonction(...)

D'où mon erreur... j'ai copié ce qu'il ne fallait pas.
Merci de ta remarque fort judicieuse

Commentaire de zeratul67 le 26/11/2005 20:36:09

Très sympa et instructif :)
Merci pour ce cours

Commentaire de neodelphi le 26/12/2005 16:46:31

Pas mal, assez utile...

C'est tout de même domage de na pas avoirs mis plus d'exemples sur le formatage des sources. La partie installation est peut être trop importante, sous linux une seule ligne de commande suffit à installer doxygen. Je met quand meme 8/10

A+

Commentaire de nightlord666 le 19/04/2006 16:43:42

Merci pour le tutorial (9/10) !

Commentaire de nightlord666 le 19/04/2006 16:46:23

Merci pour le tutorial (9/10) !

Commentaire de didi_twist le 17/11/2006 11:48:55

Merci pour le tuto, si jamais tu a le temps de le completter ca m'interresserais, car j'ai vu sur une doc en anglais qu'il y a encore de nombreuses autre possibilitée, sauf que contrairement a ton tuto on comprend pas grand chose a leur doc...

>>ça doit etre ça l'art de faire une doc... Une commande = une explication d'une disaine de ligne avec des termes techniques (tjrs en anglais) c'est assez désespérant!

Alors que ton tuto est simple et claire :
Une commande, le résultat, l'explication et les préscisions en cas de besoin.

Voila en tout cas merci et Bravo !

Commentaire de buno le 17/11/2006 16:32:33 administrateur CS

Salut Didi.
Effectivement, il y a beaucoup de possibilités pour créer une documentation plus ou moins fournie. Ce document se veut être une base pour tous les développeurs voulant utiliser Doxygen et non pas une traduction des nombreux tuto que tu peux trouver. Si tu as des questions précises, je suis à ta disposition.

Commentaire de adn_ le 07/01/2007 22:55:12

Salut,
Tout d'abord merci pour le tuto il est bien sympa.
Je voudrais savoir s'il est possible de générer de la doc pour une méthode déclarée ainsi:
(dans un fichier MaClasse.cpp)
void MaClasse::maMethode(){
...
}

par ce qu'avec un paramétrage comme décrit dans le tutorial, ça ne génère rien pour cette méthode.
Merci de me dire si vous avez des info.
++
Adn

Commentaire de buno le 08/01/2007 08:57:30 administrateur CS

Salut Adn.
Bien sûr que tu peux générer la doc d'une telle fonction, je ne vois pas le soucis. Voici un exemple:

/**
  @brief Fonction Test
  Cette fonction sert de test pour la génération de doc
*/
void MaClasse::maMethode()

Par contre, attention au doxyfile: si tu le configures pour que Doxygen n'analyse que les headers, il ne traitera pas les fichiers sources...

N'hésites pas à me contacter si tu as d'autres soucis
@+
Buno

Commentaire de PsyKroPack le 17/01/2007 16:41:56

Bonjour,

  Cela semble intéressant mais malheureusement, le tutorial est en .ppt ?! Je travaille sous Linux et trouve ca un peu dommage de fournir un tutorial sous un format propriétaire Microsoft. Résultat je ne peux le consulter et donner mon avis sur son contenu :)

  Il aurait été judicieux je pense de le mettre en pdf.

PsyKroPack

Commentaire de buno le 17/01/2007 20:02:03 administrateur CS

Salut PsyKroPack,
Effectivement, je ne proposais qu'une version PowerPoint, désolé. C'est maintenant corrigé.
Ceci dit, ce tutoriel se base sur les utilitaires version Windows pour la génération de documentation...

Commentaire de PsyKroPack le 17/01/2007 20:36:11

Je vais jeter un oeil :)
Merci d'avoir corrigé ce petit probleme

Sinon Doxygen est multiplateforme et donc indépendant du soft utilisé. Je l'utilise déja sous Linux, tout ce qui m'interesse c'est d'avoir un aperçu global des fonctionnalités offertes par Doxygen.

Merci pour la réponse rapide !

(P.S : On peut etre sous windows et utiliser des logiciels comme Open Office qui n'est pas compatible avec les "standards" MS)

Commentaire de PsyKroPack le 17/01/2007 20:49:08

Mon avis :

Ca reste très haut niveau, je pensais voir les différentes fonctionnalités de doxygen au final c'est juste une courte présentation de ce dernier. Mais en relisant la description c'est vrai qu'il est indiqué que c'est une courte présentation de doxygen.

Donc en conclusion c tutorial est intéressant pour les personnes ne connaissant pas du tout Doxygen. Pour les autres et ben vous n'y trouverez que peu d'informations.
Je relève toutefois le @code/@endcode que je ne connaissais pas.

Sinon il serait bon de signaler qu'il existe plusieurs manière de commenter son code comme :

"///" pour les commentaires courts : typiquement pour une donnée membre

Enfin voila :)

Bon tutoriel pour débuter avec Doxygen je lui met donc 7

 Ajouter un commentaire


Discussions en rapport avec ce code source dans le forum

Probleme OCX [ par lallthis ] je suis sous windows 98, et je souhaite enregistrer un ocx qui est seulement sous windows NT4Comment faire?C assez urgent, c pour un projet de bts.Si Windows ? [ par Clem ] C'est bien tout ça, mais pour windows ? Comment créér une fenêtre avec des combo, des button, des images et des labels et changer le texte de certains Pause le chargement de windows puis le reprendre AIDEZ MOI PLEASE [ par Cyberdevil ] Hello,J'ai une question :, est ce que c'est possible de "pauser" tous les processus en cours puis de les relancer en faite ce que je veux c'est inter portage Linux vers visual C++ [ par acsx ] Salut,J'ai un programme écrit en C sous Linux et je souhaite le faire tourner sous Visual C++ 6.0 sous Windows.J'ai donc créé un projet win32 et intég probleme de police [ par elladan ] j'ai installe de la ram ( 32 Mo ) qui etait grille mais windows la quand meme reconnue et a modifie des parametres du registre: mais il n'arrivait pas Problème de ligne sur Windows 98/Me [ par Toumhor ] Voilà mon problème:Lorsque je créé un stylo (HPEN) avec la méthode CreatePen avec une épaisseur > 2, les lignes que je trace avec LineTo ont des ex Problème de tracé de lignes sur Windows 98/Me [ par Toumhor ] Voilà mon problème:Lorsque je créé un stylo (HPEN) avec la méthode CreatePen avec une épaisseur > 2, les lignes que je trace avec LineTo ont des ex un GROS DEBUTANT qui a besoin d'aide, app. windows [ par stephane ] bonjour,je débute en c++, je programme déja en visual basic, je connais un peu la syntaxe de c++, mais ma question :j'ai acheter un livre c++ pour m'a Question sur Windows.h [ par GoldenEye ] Connaissez vous un site qui propose la description des fonctions de Windows.h ( même question pour dos.h )MerciGoldenEye AIDEZ MOI !!!!!! [ par mathieu ] salut,je viens de monter un pc :carte mère : MSI K7T 266 PROcarte graphique : Geforce 2 GTS winfast (LeadTek)256 mo de ram DDRet je rencontre un probl


Nos sponsors


Sondage...

Comparez les prix

CalendriCode

Février 2012
LMMJVSD
  12345
6789101112
13141516171819
20212223242526
272829    

Consulter la suite du CalendriCode

Photothèque

 
Développement réalisé par Nicolas SOREL (Nix) avec l'aide de : Cyril DURAND et Emmanuel (EBArtSoft), Merci à Vincent pour ses précieux conseils.
CodeS-SourceS.com© Toute reproduction même partielle est interdite sauf accord écrit du Webmaster
CodeS-SourceS.com© est une marque déposée tous droits réservés

Google Coop CodeS-SourceS Google Coop CodeS-SourceS
Temps d'éxécution de la page : 0,452 sec (3)

Nous contacter | Annoncer sur CodeS-SourceS | Mentions légales