Javadoc-comme la Documentation pour C++

Question

Y sont similaires, la génération de la documentation des systèmes comme Javadoc, pour le C++? Javadoc produit agréable de sortie; Ce serait formidable si vous pouvez utiliser quelque chose comme ça dans d'autres langues.

Answer 1

Il existe plusieurs outils qui fonctionne comme JavaDoc de C++ l'outil Le plus populaire est probablement Doxygen. Il peut gérer la JavaDoc-comme les commentaires, et aussi plusieurs langues (par exemple, C++, C, Java, Objective-C, Python, PHP, C#). Il est assez bon support pour peaufiner le style de la sortie HTML à l'aide de CSS (voir la liste des utilisateurs par exemple documentations).

Deux questions importantes au moment de choisir le système de documentation est de faire en sorte qu'il vous permet de

• Document les entités qui vous intéresse. Voulez-vous à la documentation de l'ordinateur à la suite de la structure de code ou selon un autre module de la division.
• Avoir une sortie formatée comme vous le souhaitez. Il est préférable lorsque la documentation s'inscrit dans avec votre style de projet.

Notre expérience avec doxygen est qu'il est assez facile à configurer et à utiliser, et le résultat est assez facile à tordre. Malheureusement, doxygen est pas parfait, donc, dans certains cas, il est nécessaire de travailler autour de défauts ou de bogues où la doxygen analyseur de tomber en panne. Assurez-vous d'inspecter l'ensemble de votre documentation générée avec soin.

Answer 2

Vous ne pouvez pas utiliser la javadoc, mais il existe quelques outils qui font ce que vous voulez. La plupart des gens ont tendance à utiliser est Doxygen. Voici quelques liens pour Doxygen et Doc++:

Doxygen
Doc++

Answer 3

Il y a Doxygen

Answer 4

Il est également qdoc pour QT C++ basées sur des projets. http://doc-snapshot.qt-project.org/qdoc