Bonjour,
dans cet article, je vais vous présenter Doxygen, un utilitaire permettant de générer une documentation à partir du code source d’un programme
Doxygen supporte plusieurs languages : C, C++, Java, Objective C, Python, IDL, VHDL
Mais comment ça marche ?
Ce programme se sert des commentaires suivant une règle précise que vous devrez insérer dans votre code. Voilà un petit exemple :
/*! \class fullDialog
* \brief classe representant la fenêtre plein ecran
*
* Cette classe gère l’affichage du QPixmap, et la gestion des evenements souris et de dessin.
*/
class fullDialog : public QLabel
{
Q_OBJECT
public:
/*!
* \brief Constructeur
*
* Constructeur de la classe fullDialog
*
* \param parent : widget parent
* \param flags : flag de ce widget
*/
fullDialog(QWidget *parent=0, Qt::WFlags flags=0);
}
Un peu long, mais regardez ce que ça donne pour mon logiciel lScreen : http://coindugraphisme3d.free-h.net/doc/html/ Pas mal hein
Un petit peu d’effort, mais un excellent résultat. Par exemple des projets tels que KDE ou metacity l’utilise pour réaliser leur documentation
(un grand nombre des projets : http://www.stack.nl/~dimitri/doxygen/projects.html )
Comment l’installer ?
sous linux un petit
sudo apt-get install doxygen
sudo apt-get install doxygen-gui
et le voilà en place avec une interface graphique.
Sous windows, téléchargez l’executable ici : http://logiciel.codes-sources.com/logiciels/doxygen-91.aspx (je n’ai pas pu tester ^^ )
Bonne création de documentation
Malgon
Liens externes