Extracteurs de documentation
Contents
1. Plan e Quoi Pourquoi Qui e Quand e Comment O e Javadoc Doxygen II Quoi Plusieurs niveaux de documentation e Article scientifique e Specification document de d veloppement architecture Manuel de reference Manuel utilisateur tutoriaux Manuel d installation compilation Pourquoi e D finir a qui s adresse la documentation que l on va crire e Planning de d veloppement e le temps passe documenter ne l est pas rajouter des fonctionnalit s e Trouver l quilibre entre trop et pas assez de documentation Besoins diff rents pendant et apr s le d veloppement Qui Quand Qui Tout le monde doit documenter un minimum son code Ne pas esp rer que quelqu un le fera a votre place Ne pas confondre commentaire et manuel de r f rence Quand e Deux extr mes Tout documenter en m me temps que l on r dige le code Attendre la fin des d veloppements Adopter une attitude interm diaire Comment Ou Extraction automatique e Garder synchrone code et documentation e Une documentation obsol te est une documentation inutile e Commentaires format s e Graphe de d pendance entre les classes les fichiers e Hierarchie de classes Des dizaines d outils Non commerciaux AutoDOC Autoduck CcDoc CppDoc Cxref cxxwrap Cxx2HTML C2HTML Doc DocClass Doxygen DoxyS Doxygen fork spinoff Epydoc g2. es e G n ration de la doc doxygen myproj doxy e Sous linux pour une ex cution rapide nettoyer PATH et LD_LIBRARY_PATH Doxygen format des commentaires la javadoc O pour le C e A la d claration ou la d finition des fonctions Possibilit de fichier de documentation s par e HTML embarqu possible e Des dizaines de tags commands Doxygen cr ation de listes list of events MOUSE EVENTS MOUS more Swee mouse click event n More info about the click event mouse double click event keyboard events key down event key up event More text here Doxygen grouper ingroup defgroup addtogroup II Doxygen utiliser des formules mathematiques Support des formules LaTeX e G n ration de l image avec latex et gs Exemple The distance between f x_1 y_1 f and f x_2 y_2 f is ff sart x_2 x 1 2 y 2 y 1 12 f The distance between m and wa ya IS es ai ya yi Doxygen les graphes e class graph e include graph e collaboration graph e call graph Nm3 NURBSCurve3 lt Real Nm3NURBSCurve3 h Doxygen preprocessing ENABLE_PREPROCESSING YEO MACRO_EXPANSION YES EXPAND ONLY PREDEF YES PREDEFINED _ declspec x Doxygen reverse engineering EXTRACT_ALL TES EXTRACT_PRIVATE AB EXTRACT STATIG YES SOURCE_BROWSER YES INLINE SOURCES YES
3. CLASS_DIAGRAMS YES HIDE_UNDOC_RELATIONS NO HAVE_DOT YEo CLASS_GRAPH YES COLLABORATION_GRAPH YES INELUDE_GRAPH YES INCLUDED BY GRAPH YES DIRECTORY_GRAPH ib Conclusion L extracteur de doc ne documente pas votre place e Comme il y a des r gles de codage il faut d finir des r gles de documentation e Le manuel de r f rence n est pas le seul manuel produire
4. ng te display Tt che text as null gt the tool tip is turned Sfr for tnis component cee publie vond set loolliplext String text Javadoc possibilit d extension e tag OU taglet permet de g rer de nouveaux tags Doclet Exemple de doclet DocCheck http java sun com j2se javadoc doccheck 9 javadoc doclet com sun tools doclets doccheck DocCheck docletpath doccheck1 2b2 doccheck jar java Produire du PDF http sourceforge net projects pdfdoclet Javadoc avantages et limites e Mono langage e Simple e Coh rent avec les conventions Java e Pr sentation HTML seulement e Peut se lancer sur toute une hi rarchie e Extensible avec les doclets pour d autres formats de sorties Doxygen http www doxygen org e Supporte C C Java Objective C Python IDL Corba et Microsoft et dans certaines limites PHP C and D Tout Unix et Windows e Sorties HTML LaTeX RTF Man XML PerlMod Aide Windows e Inspir de doc et de la documentation Qt e Plus labor fichier de configuration wizard d aide la configuration e g n ration de graphes avec graphviz dot e g n ration d un moteur de recherche pour site web avec PHP e possibilit de se lier de la doc d j g n r e par des fichiers tag Doxygen utilisation e Cr ation d un fichier de config 9 doxywizard 9 doxygen g Mypro7 doxy e Edition du fichier de configuration options comment
5. tk doc HappyDoc HeaderDoc HTMLgen HyperSQL Javadoc KDoc Natural Docs Perceps phpDocumentor PHPDoc ReThree C RoboDoc ScanDoc Synopsis Tydoc VBDOX Commerciaux DocBuilder DocJet Doc o matic ObjectManual Together CC Rider VBXC http www doxygen org links html Javadoc http java sun com j2se javadoc e Extracteur sp cialis java tres simple Ceci est un commentaire ignor par l extracteur 7 Cela aussi e We mom mel do e Produit du html en sortie e javadoc optionl option2 nomDeFichier java Javadoc position dans le source I we Gem rn ommem ae ek public class uneClasse See Sie nel comientrelree ale rr b m pub e ee j Ceci est un commentaire de m thode public void uneMethode Seuls les items public et protected sont pris en compte dans l option par d faut Javadoc formatage du texte HTML Javadoc les tags param classes interfaces methods and constructors only return exception author version see since serial deprecated Glink methods only throws is a synonym added in Javadoc 1 2 classes and interfaces only classes and interfaces only or serialField or serialData see How and When To Deprecate APIs Javadoc utilisation des tags Registers the text to display in a tool tip The text displays when the cursor lingers over the component dparam text tche stri
Download Pdf Manuals
Related Search