|
Garder source code maintenable est l'un des défis les plus difficiles tout développeur de logiciel , que ce soit un loup solitaire programmeur ou un membre d'une grande équipe . Doxygen vous permet de générer automatiquement la documentation de C + + , Java ou autre code. Il analysera votre code sans papiers et écrire la documentation de base, et vous pouvez ajouter des commentaires spécialement formatés à votre code source pour faire des ajouts utiles au code source généré . Choses que vous devez
Source Code
Text Editor
Afficher plus Instructions
1 Télécharger et installer Doxygen . Il est disponible à stack.nl /~ dimitri /doxygen /download.html # latestsrc .
2 Ouvrez une invite de commande . Sous Windows XP, vous pouvez le faire en cliquant sur le menu Démarrer , choisir Exécuter, entrer "cmd" et cliquez sur OK . Sous Mac OS, vous pouvez cliquer sur le menu Spotlight , le type Terminal Server, Terminal et choisir quand il apparaît . Naviguer l'invite de commande dans votre répertoire de code source en tapant " cd" suivie du nom du répertoire et appuyer sur Entrée .
3 Créer un Doxyfile en tapant " doxygen - g" et en appuyant sur Entrée. Cela va générer un fichier dans le répertoire courant appelé " Doxyfile ", qui contiendra toutes les options de Doxygen par défaut. Vous pouvez modifier ces options en ouvrant la Doxyfile dans un éditeur de texte.
4 ajouter des commentaires Doxygen à votre code source. Commentaires Doxygen des commentaires normaux qui contiennent des annotations spéciales qui lui permettent Doxygen les trouver et indiquer comment il doit les utiliser. Par exemple, si vous écrivez dans une langue C- style, vous pouvez ajouter une brève description de fonction en ajoutant le commentaire suivant avant sa déclaration :/* ! \\ bref Ma brève description * /Vous pouvez voir tous les autres Doxygen d' annotations supporte au stack.nl /~ dimitri /doxygen /docblocks.html .
5 type " doxygen Doxyfile " sur votre invite de commande et appuyez sur Entrée. Cela va générer la documentation de votre code source.
|
