manuel officiel de doxygen

doxygen est un outil auxiliaire utile pour les programmeurs. Il peut faciliter l'ajout de code batch au programme. Il est compatible avec les langages de programmation traditionnels tels que C++, C, Java, Objective-C, Python, etc. Le manuel chinois doxygen fourni par l'éditeur comprend Il contient une introduction de base, des compétences grammaticales et avancées, etc., vous permettant de démarrer rapidement. Si vous en avez besoin, vous êtes invités à le télécharger.

Introduction de base

Doxygen prend déjà en charge la génération de fichiers de répertoire chm codés ANSI (index.hhc) ! Doxygen est généralement utilisé pour générer des documents en anglais. La génération de documents chinois nécessite de modifier les systèmes de codage d'entrée et de sortie, ce qui peut changer la méthode d'analyse et générer des documents chinois. Cependant, vous devez être conscient que Doxygen doit effectuer une analyse grammaticale lors de l'extraction d'informations à partir de commentaires. Ces analyses sont basées sur l'anglais et il est impossible de prendre en charge le chinois à ce niveau.

Doxygen est un générateur de documentation pour les langages C++, C, Java, Objective-C, Python, IDL (saveurs CORBA et Microsoft), Fortran, VHDL, PHP, C# et D. Peut fonctionner sur la plupart des systèmes de type Unix, ainsi que sur les systèmes d'exploitation Mac OS X et Microsoft Windows. La crackée initiale de Doxygen a emprunté du code à l'ancienne crackée de DOC++ ; par la suite, le code source de Doxygen a été réécrit par Dimitri van Heesch ;

Le manuel doxygen est divisé en trois parties, chaque partie contient plusieurs chapitres.

La première partie est le guide d'utilisation

1. Installation, explique comment télécharger, compiler et installer doxygen sur votre plateforme.
2. Commençons par vous expliquer comment générer rapidement le premier document doxygen.
3. Documentation du code, démontrant plusieurs façons dont le code peut être documenté.
4. Liste, montrant plusieurs façons de créer une liste.
5. Combinaison, montrant comment combiner certains travaux ensemble.
6. Contient des formules, montrant comment insérer des formules dans le document.
7. Graphiques et tableaux, décrivant les tableaux et graphiques générés par doxygen.
8. Prétraitement et analyse de la manière dont doxygen gère les définitions de macros.
9. Générez des liens automatiques qui montrent comment placer des liens vers des fichiers, des classes et des membres dans le document.
10. Format de sortie, montrant comment générer différents formats de sortie pris en charge par doxygen.
11. Recherche, montrant plusieurs façons de rechercher dans les documents HTML.
12. Sortie personnalisée, analysez comment générer une sortie personnalisée dans doxygen.
13. Commandes personnalisées, montrant comment définir et utiliser des commandes personnalisées dans vos commentaires.
14. Connectez-vous à des documents externes et expliquez comment laisser doxygen créer des liens vers des documents générés externes.
15. FAQ, réponses aux questions fréquemment posées.
16. Dépannage : il vous indique quoi faire en cas de problème.

La deuxième partie est le guide de référence

1. Fonctionnalités, montrant un aperçu des fonctions de doxygen.
2. Historique de Doxygen, informant doxygen des changements au cours du processus de développement et de ce qu'il a fait.
3. Utilisation de Doxygen, expliquez comment utiliser doxygen.
4. Utilisation de Doxytag, expliquez comment utiliser doxytag.
5. Utilisation de doxywizard, expliquez comment utiliser doxywizard.
6. Utilisation d'Installdox, indiquez comment utiliser le script installdox généré dans doxygen si vous utilisez des fichiers de balises.
7. Configuration, expliquant comment ajuster doxygen pour générer la documentation dont vous avez besoin.
8. Mots de commande spéciaux, donnant un aperçu des commandes spéciales pouvant être utilisées dans le document.
9. Mots de commande HTML, qui fournissent un aperçu des commandes HTML pouvant être utilisées dans le document.
10. Mots de commande XML, qui fournissent une présentation des commandes XML de style C# pouvant être utilisées dans les documents.

La troisième partie fournit quelques informations pour les développeurs de doxygen (omise)

1. Structure interne de doxygen, donnant un aperçu global de la structure interne de doxygen.
2. Format de sortie du module Perl, montrant comment utiliser la sortie de PerlMod.
3. Internationalisation, analyse de la manière d'ajouter un support de sortie pour de nouvelles langues.