Documentation de type Javadoc pour C++
Existe-t-il des systèmes de génération de documentation similaires comme Javadoc, pour C++? Javadoc produit une belle sortie; ce serait génial si vous pouviez utiliser quelque chose comme ça dans d'autres langues.
5 réponses
Il existe plusieurs outils qui fonctionnent comme JavaDoc pour C++ L'outil le plus populaire est probablement Doxygen . Il peut gérer des commentaires de type JavaDoc, ainsi que plusieurs langages (par exemple, C++, C, Java,Objective-C, Python, PHP, C#). Il a un assez bon support pour peaufiner le style de la sortie HTML en utilisant CSS (Voir la liste des utilisateurs par exemple les documentations).
Deux questions importantes lors du choix du système de documentation est de s'assurer qu'il vous permet à
- documentez les entités qui vous intéressent. Voulez-vous documenter le système en suivant la structure de code ou en fonction d'une autre division de module.
- Obtenir la sortie formatée comme vous le souhaitez. Il est préférable lorsque la documentation correspond à votre style de projet général.
Notre expérience avec doxygen est qu'il est assez facile à configurer et à utiliser, et le résultat est assez facile à tordre. Malheureusement, doxygen n'est pas parfait, donc dans dans certains cas, il est nécessaire de contourner les bizarreries ou les bogues où l'analyseur doxygen tombe en panne. Assurez-vous d'inspecter soigneusement toute la documentation générée.
Il existe également qdoc pour les projets c++ basés sur QT. http://doc-snapshot.qt-project.org/qdoc
Je commence tout juste à utiliser Sphinx pour mes projets Python. Sa page d'accueil indique "C / c++ est déjà pris en charge".
Il utilise un balisage léger appelé " reStructuredText ".
Je viens de commencer à l'utiliser pour mes projets Python, et j'aime beaucoup le look de la sortie.