Qu'est-ce que Doxygen, quel rôle a-t-il?
Doxygen est un système de documents multiplateforme open source décrit dans un style JavaDoc, prenant entièrement en charge les langages C, C ++, Java, Objective-C et IDL , et prenant partiellement en charge PHP et C #. La syntaxe des commentaires est compatible avec Qt-Doc, KDoc et JavaDoc. Doxgen peut démarrer à partir d'un ensemble de fichiers sources archivés et générer des navigateurs en ligne au format HTML ou des manuels de référence LATEX et RTF hors ligne.
Doxygen est un outil de génération de fichiers programme qui peut convertir des commentaires spécifiques du programme en fichiers de description. Habituellement, lorsque nous écrivons un programme, nous écrivons des commentaires plus ou moins, mais pour d'autres, nous devons explorer directement les commentaires dans le programme, ce qui est aussi difficile que de sauver le Titanic. Les commentaires les plus utiles appartiennent aux descriptions des fonctions, des catégories, etc. Par conséquent, si vous pouvez réorganiser les commentaires en un manuel de référence pur en fonction de la structure du programme lui-même, cela réduira beaucoup de charge pour ceux qui utiliseront votre code de programme plus tard. Cependant, à l'inverse, le travail d'organisation des documents est un lourd fardeau pour vous.
Doxygen est lorsque vous écrivez un commentaire, selon certaines des règles qu'il définit. Ensuite, il peut vous aider à produire de beaux documents. Par conséquent, l'utilisation de Doxygen peut être divisée en deux parties. La première consiste à rédiger des commentaires dans un format spécifique, et la seconde à utiliser les outils de Doxygen pour générer des documents.
Construction d'environnement; téléchargement de logiciels
- Adresse de téléchargement-téléchargement de Doxygen: http://www.onlinedown.net/soft/117010.htm
- htmlhelp adresse de téléchargement-téléchargement: http://msdn.microsoft.com/en-us/library/ms669985.aspx (Si vous voulez que votre Doxygen génère automatiquement chm, veuillez télécharger HTML Help Workshop, nous utiliserons hcc. fichier exe et DLL connexe.)
- Adresse de téléchargement-téléchargement de Graphviz: http://www.skycn.com/soft/appid/6971.html (graphviz est une boîte à outils open source lancée par AT & T Labs, utilisée pour dessiner les graphiques décrits par le script de langage DOT. Doxygen utilise graphviz génère automatiquement des graphiques de relation d'appel entre les classes et les fichiers. Si vous n'avez pas besoin de cette fonction, vous ne pouvez pas installer la boîte à outils.)
Construction d'environnement; application logicielle
Après l'installation, commencez à configurer l'outil Doxygen et exécutez Doxywizard. L'interface suivante apparaîtra
Construction de l'environnement; configurer le répertoire de travail
Cliquez sur Sélectionner pour choisir votre propre répertoire d'installation de Doxygen
Onglet Assistant de configuration; configurer le projet
Modifiez d'abord le nom du projet, sélectionnez le répertoire pour analyser le code source, répertoire du code source:, cochez Analyser récursivement (analyse récursive), puis sélectionnez le répertoire de sortie.
Configurer le modèle
Dans le Mode sous Rubriques de l'Assistant, sélectionnez Toutes les entités pour générer des fonctions relativement complètes. Le fait que le code source soit inclus ou non dépend de votre propre situation. Choisissez votre langue ci-dessous. Ici, l'auteur utilise C ++
Dans Sortie, veuillez vérifier si vous devez sortir le format chm.
Choisissez d'utiliser le package GraphViz dans les diagrammes pour sortir UML
Référence de l'article: https://blog.csdn.net/Andy_93/article/details/53125776
