GestionDeDocumentation
Contents
1. Gestion automatique de documentation Table des mati res FAC LOAD LATEA TEL AN OT ON 2 A EEE E E E dr 2 Aia LS nr et isa date teens tete OC os ds 2 O tilscommerci d k UE le ns mines eue 2 Doxy Seia annn Ne nt ta Site le cine teen 3 A O n Ee A EEE EA E EE e EE EEEE A AE ETE sew E EA EOE AEE ETE E ETE 3 AAT ACTCTISEL A O 3 A 3 En liene de commande A id 3 En version GUI Graphic User Interface ia dls 3 Fes dierent ES a A leads 4 PCV asta ts Mad ER E ET E ET 4 OSE NO 4 RS en SR a ee a da as 4 CS ISLES RU OR SN ee ee let teen 4 R MIDIOS Tentes ei atonacaden creases ec ln a en a 5 A 5 IO LOANO a i 2 ii TEE 5 MESSE A EAE EE E E E E EAST 6 Les autres pages de docu MMM ias 6 LLAVES ER ss iia 7 pe eh cs 1 of A TE 7 A A NC EA CR ease eae 7 LT LaSalle Avignon 1 7 O 2005 BTS IRIS tv Gestion automatique de documentation L auto documentation Besoins La morale dit qu il faut documenter ses programmes Premi re question pourquoi documenter gt mon employeur ou le client la demande gt je travaille dans une quipe de d veloppement gt pour mieux comprendre mon code lorsque je retravaille dessus x on se sent mieux avec Deuxi me question pourquoi utiliser un syst me de documentation automatique gt elle sera toujours jour r utiliser les commentaires d j ins r s dans les sources choisir le format de sortie HTML PDF RTF obtenir des r f rences crois es permett2. throw package interface Les d finitions fe Em JEN JEI define LIBRE def LIBRE def JOUEUR define JOUEUR identifie une case de libre 0 identifie le joueur 1 def ORDI identifie l ordi define ORDI 2 def FINI tat de la partie define FINI 3 Remarques voir aussi typedef enum union struct Les autres pages de documentation Les commandes sp ciales permettent de cr er des pages mainpage et page de documentation structur es en sections section et sous sections subsection contenant des liens de r f rence crois e ref mainpage Page principale du projet morpion fe A ACA ACA F F F Nw A A A ACA CACA CACA CA A F F F F KF F F Vs Xx Ey section intro Introduction Jeu de morpion en langage C n L objectif est de jouer une partie contre l ordinateur et de le battre section tdm Table des mati res ref pagel ref licence ref aboutl page pagel Documentation ref Installation ref Usage ref Configuration Voir aussi la page ref aboutl subsection Installation Manuel d installation c make c dep c make c all Nc make c install subsection Usage Manuel d utilisation Taper c morpion et le jeu d marr Utiliser 1 pav num rique pour jouer un pion sur le plateau de jeu Le programme
3. able disponible pour les plate formes Unix Window et MacOS X compatible avec Javadoc Qt Doc et KDOC e reconnaissance automatique et g n ration de r f rences crois es utilisation de la coloration syntaxique g n ration automatique de diagrammes de classe organisation par groupe pour des documentations sp cialis es etc Utilisation En ligne de commande 1 G n rer le fichier de configuration doxygen g filename ou filename doxy 2 Editer le fichier de configuration vim filename et adapter les options en fonction du r sultat d sir par exemple PROJECT_NAME Mon Projet PROJECT_NUMBER 1 0 OUTPUT_DIRECTORY home tv tv tmp monProjet doc OUTPUT_LANGUAGE French EXTRACT_ALL YES SOURCE_BROWSER YES GENERATE_HTML YES INPUT home tv tv tmp monProjet src FILE_PATTERNS c Remarque l ensemble des options de configuration sont accessibles l adresse suivante http www stack nl dimitri doxygen config html ou en local dans usr share doxygen 1 2 18 3 G n rer la documentation doxyden filename En version GUI Graphic User Interface Utiliser doxywizard LT LaSalle Avignon 3 7 O 2005 BTS IRIS tv Gestion automatique de documentation Les diff rents styles Doxygen reconnait deux styles de commentaires Javadoc style et Qt style Javadoc style Fonction documentation param x Le param tre return La valeur retourn see autreFuncti
4. ant une meilleure navigabilit r cup rer les parties importantes en signification des sources on travaille moins X VV VV Troisi me question pourquoi doxygen gt il correspond aux besoins exprim s ci dessus gt il est free gratuit et libre gt il est simple rapide et configurable x on m oblige l utiliser Outils non commerciaux AutoDOC Autoduck Cocoon CcDoc CppDoc Cxref cxxwrap Cxx2HTML C2HTML Doc DocClass Epydoc gtk doc HappyDoc HeaderDoc HTMLgen HyperSQL Javadoc KDoc Natural Docs Perceps phpDocumentor PHPDoc ReThree C RoboDoc ScanDoc Synopsis Tydoc VBDOX Outils commerciaux DocBuilder DocJet Doc o matic ObjectManual Together CC Rider VBXC LT LaSalle Avignon 2 7 2005 BTS IRIS tv Gestion automatique de documentation Doxygen Introduction Doxygen est un outil qui permet de g n rer automatiquement une documentation format e navigable et imprimable a partir de fichiers sources sp cialement pr par s a son effet Doxygen supporte les langages C C Java et IDL en utilisant deux styles diff rents de documentation Doxygen est capable de produire des documentations en HTML LATEX XML et RTF Rich Text Format En utilisant des outils additionnels on pourra aussi fournir une documentation dans beaucoup d autres formats tel que PDF pages man PostScript compressed HTML HTML Help chm et Micro oft Word Caract ristiques e port
5. la documentation associ e au format HTML LT LaSalle Avignon 117 O 2005 BTS IRIS tv
6. morpion est sous ref licence subsection Configuration Configuration requise Linux et la page aboutl author a tv version 1 0 date b 2005 libc so 6 A propos Licence GPL page licenc LT LaSalle Avignon 6 7 2005 BTS IRIS tv Gestion automatique de documentation x w This program is free software you can redistribute it and or modify h it under the terms of the GNU General Public License as published by x the Free Software Foundation either version 2 of the License or at your option any later version x This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the GNU General Public License for more details x You should have received a copy of the GNU General Public License K along with this program if not write to the Free Software Foundation Inc 59 Temple Place Suite 330 Boston MA 02111 1307 USA x El Travaux pratiques S quence 1 1 R cup rer l archive du projet Morpion et avec doxywizard g n rer diff rents types de documentation HTML en regardant notamment les options GENERATE_TREEVIEW EXTRACT_ALL GENERATE_xxxLIST TODO TEST 2 Puis g n rer une documentation au format RTF et utiliser OpenOffice Writer pour la lire S quence 2 1 Documenter la partie ihm du projet Morpion et g n rer
7. n plus d taill e ay Remarques Les commandes sp ciales bug warning todo et test g n reront des listes s par es Certaines commandes sp ciales author date file peuvent tre combin es avec un gestionnaire de versions comme RCS CVS Author Date Les fonctions fn verifierPlateau int plateau brief v rifie le plateau de jeu a la recherche d un gagnant ou d un match nul param plateau int pointeur sur le tableau de jeu return gagne int tat de la partie en cours retval gagne JOUEUR ORDI FINI todo la recherche de l tat de la partie en cours JOUEUR ORDI FINI warning non impl ment renvoie toujours 0 test le joueur ou l ordi a align 3 pions verticalement horizontalement ou diagonalement n partie finie sans gagnant gt match nul ex int verifierPlateau int plateau lis fn jouerOrdi int plateau brief permet l ordinateur de jouer un pion param plateau int pointeur sur le tableau de jeu return joue int indique si l ordinateur a pu jouer retval joue 0 1 todo int grer l IA sa jouerPosition int plateau int position Li int jouerOrdi int plateau Lou LT LaSalle Avignon 5 7 O 2005 BTS IRIS tv Gestion automatique de documentation Remarques voir aussi var et en C Java class exception
8. on simple ligne de documentation simple ligne de documentation int a lt la documentation est apr s Qt style Fonction documentation fn laFoction int x brief une br ve description param x Le param tre return La valeur retourn e sa autreFunction simple ligne de documentation simple ligne de documentation char b lt la documentation est apr s Qt style Les commandes sp ciales Doxygen interpr te les commandes sp ciales plac es dans le code source afin de documenter celui ci I existe de nombreuses commandes sp ciales les plus utilis es sont pr sent es dans les exemples ci dessous L ensemble des commandes sp ciales http www stack nl dimitri doxygen commands html ou en local dans usr share doc doxygen 1 2 18 Les listes Doxygen permet de cr er des listes simples num rot es ou directement en HTML par exemple Une liste iteml item2 x sous item21 x sous item22 item3 LT LaSalle Avignon 4 7 2005 BTS IRIS tv Gestion automatique de documentation Exemples Les sources file jeu c brief Gestion du jeu author a tv x version 1 0 date b 2005 bug fin de partie non g r e warning certaines fonctions ne sont pas impl ment s todo verifierPlateau int plateau test Une descriptio
Download Pdf Manuals
Related Search
GestionDeDocumentation gestion de documentation