Discussion :

[Aleph69]

Bonjour,

j'ai l'habitude d'utiliser doxygen pour générer automatiquement la documentation de mes codes mais je me demande si c'est le mieux adapté au C++. En cherchant un peu sur la toile, je pensais que je ne trouverais pas beaucoup d'alternatives... finalement il y en a beaucoup trop :
http://en.wikipedia.org/wiki/Compari...Output_formats
Ce tableau n'est d'ailleurs pas exhaustif. Je suis par exemple tombé sur cette solution qui m'a l'air intéressante :
http://www.doxys.dk/doxys_homepage/S...scription.html

Quelle(s) solution(s) utilisez-vous?

Merci!

[djuju]

Doxygen... C'est presque un standard !
En tout cas, tout le monde à l'habitude de naviguer dans ce type de doc, pas de risque d'être perdu. Je trouve ça plutôt simple à écrire. Et j'ai pas l'impression de manquer de fonctionnalités.

À part la curiosité, es-ce que quelque chose te pousse à explorer d'autres solutions ?

[Neckara]

Bonjour,

Même avis que djuju, j'utilise doxygen, simple d'utilisation, on peut faire de très bonnes documentations (cf la doc de la SFML), et il me semble qu'on peut même générer quelques diagrammes avec.

[mitkl]

Oui on peut générer des diagrammes avec GraphViz en complément de Doxygen et c'est vraiment très pratique !

[Aleph69]

Je regarde plus par curiosité qu'autre chose. Je n'ai pas la dernière version, cela s'est peut-être amélioré, mais je me souviens par exemple que l'insertion de commandes Latex dans les commentaires n'était pas particulièrement bien pensée à l'époque. J'ai souvenir également que dès que l'on utilise des templates, on obtient des choses difficilement lisibles (graphes avec Graphviz compris). Je pense à ce genre de choses :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

template<typename T1,template<typename,size_t> class T2,size_t T3> class Foo : public T2<T1,T3> {};

Je vais tout de même refaire un test par acquis de conscience.

[Luc Hermitte]

Doxygen aussi... en attendant qu'un projet bâti autour de clang ne surgisse (ce qui ne manquera pas AMA)

[Klaim]

Doxygen aussi... en attendant qu'un projet bâti autour de clang ne surgisse (ce qui ne manquera pas AMA)

Vivement que ça marche sous windows...

[Aleph69]

Bonsoir,

j'ai finalement commencé à tester la nouvelle version de Doxygen et je maintiens que ce n'est pas terrible, ou alors je l'utilise mal. Par exemple, le traitement des spécialisations partielles ne me convient pas du tout puisque la documentation de ces dernières n'est pas prise en compte, typiquement avec la commande \brief.

Quelqu'un a-t-il réussi à contourner le problème?

EDIT : au temps pour moi, c'est dû à la présence de templates variadiques qui ne doivent pas être encore supportés.