C'est une bonne occasion de présenter très brièvement ce qui devrait faire partie de toute boîte à outils d'un bon programmeur.
Doxygen est donc un logiciel permettant de documenter facilement son code par un système de commentaire-tags. Les utilisateurs de javadoc, par exemple, se retrouveront facilement dans la manière de procéder, cependant on dénombre près de 170 tags par défaut pour doxygen auquel s'ajoute un système permettant d'ajouter ses propres tags afin de répondre aux besoins du projet.
En plus de la documentation des sources (prototype des fonctions, des classes), on peut obtenir les informations suivantes :
- Liste des fichiers inclus;
- Documentation des structures de données;
- Hiérarchie des classes;
- Différents types de graphiques : diagrammes de classe, de collaboration, d'appels, d'inclusion, etc;
- Un index de tous les identifiants;
- Des fichiers sources annotés.
La documentation produite est généralement au format HTML à cause de sa facilité d'emploi, cependant il est possible d'obtenir des fichiers LATEX, PostScript, PDF, XML, man et même Word et CHM.
Doxygen a été écrit en grande partie par Dimitri van Heesch qui trouvait, à l'époque, la documentation générée pour Qt très jolie et doc++ trop limité pour réaliser un travail similaire.
Aujourd'hui doxygen supporte C/C++, Java, (Corba et Microsoft) Java, Python, IDL, C#, Objective-C et en partie D et PHP.
Doxygen est distribué sous licence GPL, un binaire est disponible pour Windows 95 à XP et pour Mac OS X mais toute bonne distribution doit le mettre à disposition (nécessite la libqt).
![[en]](../images/en.png)
Le site de doxygen (1000 hits)-
Le changelog (143 hits)
-
La page de téléchargement (264 hits)
> Lire la dépêche (24 commentaires, moyenne: 3,3).
Vous avez demandé le commentaire #766576.
Run by 
Cette page a été générée par Templeet en 0.0708s (dont 0.0091 de SQL).
Cette page est peut-être conforme xhtml 1.0.
Information sur le site.
UTF-8 ?
Cette année j'ai eu à utiliser Doxygen ... et le problèyme c'est que mes fichiers sources sont codés UTF-8, du coup doxygen avait un peu de mal, pensant qu'il s'agissait d'iso-8859-1[5].
Alors, c'est possible de configurer doxygen pour qu'il gère l'utf-8 ? D'après ce que j'avais vu sur google, cela ne semblait pas être le cas.
La Roue du Temps
[^]Re: UTF-8 ?
Je rencontre le même problème. En utilisant les entités HTML, ça passe comme il faut, même pour le pdf.
[^]Re: UTF-8 ?
C'est quoi les entités HTML ?
[^]Re: UTF-8 ?
Des exemples plutôt qu'un long discours :
É -> É
é -> é
è -> è
ë -> ë
ä -> ä
© -> ©
[^]Re: UTF-8 ?
Enfin, jai une touche é sur mon clavier, ce n'est pas pour rien, enfin j'espère :'-(
La Roue du Temps
[^]Re: UTF-8 ?
Euh, je suppose que tu veux utiliser « é » pour des mots comme « café » ou « fiancey », mais ne me dis pas que tu commentes ton code en Français quand même ?
;-)
[^]Re: UTF-8 ?
En quoi cela pose problème de commenter en français? :o
[^]Re: UTF-8 ?
Par souci d'intéropérabilité avec les développeurs du monde entier, il vaut mieux utiliser le volapuk ou le latin.
[^]Re: UTF-8 ?
Moi, je code exclusivement mes projets open source en esperanto pour que tout le monde puisse contribuer...
[^]Re: UTF-8 ?
J'ai travaillé sur des projets où l'utilisation du français était obligatoire pour toute la documentation, commentaires du code inclus.
Ça serait donc effectivement sympa que l'utf8 soit supporté.
[^]Re: UTF-8 ?
En l'occurence, je commente en anglais, sauf dans les projets de l'IUT :)
La Roue du Temps
[^]Re: UTF-8 ?
Si je te dis que j'ai trouvé des commentaires en Allemand dans le code source d'OpenOffice, tu comprends de quoi je parle ? (lesdits commentaires datant vraissemblablement de StarOffice, propriétaire et développé par une boite allemande)
Enfin, j'ai un copain qui bossait sur du code commenté en polonais, mais il a appris plus tard que les commentaires importants étaient ceux en anglais. Le polonais, c'était juste pour les trucs genre « penser à acheter des poireaux en rentrant ce soir » ;-).