Doxygen
Doxygen /ˈdɑːksiɡən/ És un generador de documentació, una eina per escriure documentació de referència del programari.[1][2][3][4][5] La documentació és escrita dins del codi. D'aquesta manera, és relativament fàcil de mantenir actualitzada la documentació. Doxygen enllaça la documentació i el codi, de manera que el lector d'un document fàcilment pot referir al codi real.
Doxygen és programari lliure, alliberat sota els termes del GNU Llicència Pública General.
Disseny
Com Javadoc, Doxygen extreu documentació dels comentaris als arxius font. A més de la sintaxi pròpia de Javadoc, Doxygen suporta les etiquetes utilitzades en el Qt toolkit i pot generar sortida en HyperText Markup Llengua (HTML) així com Microsoft Compiled HTML Help (CHM), Format de Text Ric (RTF), Format de Document Portàtil (PDF), LaTeX, Postdata o pàgines de manual.
Usos
La llista de llenguatges de programació suportats per Doxygen inclou C, C++, C♯, Fortran, IDL, Java, Objectiu-C, Perl, PHP, Pitó, Tcl, VHDL i altres.[6][7][8][9][10][11]
Es pot executar damunt la majoria de sistemes semblants a Unix, Mac OS X i Finestres.
La primera versió de Doxygen es va basar en el codi d'una versió primerenca de DOC++ (desenvolupat per Roland Wunderling i Malte Zöckler a Zuse Institut Berlín); més tard, el codi de Doxygen va ser reescrit per Dimitri van Heesch.
Codi d'exemple
La sintaxi genèrica de comentaris de documentació és començar un comentari amb un asterisc extra després del delimitador de comentari '/':
A molts programadors els agrada marcar l'inici de cada línia amb espai-asterisc-espai, de la manera següent, però que no és necessari.
Molts programadors eviten utilitzar comentaris d'estil C i en comptes d'això utilitzar comentaris de línia estil C++. Doxygen accepta comentaris amb una barra addicional com Doxygen comentaris.
El següent il·lustra com un arxiu font en C++ pot ser documentat.
Una aproximació alternativa per documentar els paràmetres és mostrat a sota. Produirà la mateixa documentació.
L'us d'un llenguatge de marques més ric també és possible. Per exemple, es poden afegir equacions fent servir LaTeX:
Veure també
- Comparació de generadors de documentació
- Graphviz
- Mscgen
- Escriptor d'API
Referencies
- ↑ FAQ: How did doxygen get its name?
- ↑ Perkel, Jeffrey M. «Get With the Program: DIY tips for adding coding to your analysis arsenal». The Scientist. The Scientist, 22-11-2015.
- ↑ Sabin, Mihaela. «Doxygen». OpenComputing. University of New Hampshire, 22-11-2015.
- ↑ «Doxygen». Free Software Directory, 22-11-2015.
- ↑ «Documentation». Rosetta Code, 22-11-2015.
- ↑ «Documentation: C». Rosetta Code, 22-11-2015.
- ↑ «Documentation: Objective-C». Rosetta Code, 22-11-2015.
- ↑ http://search.cpan.org/~jordan/Doxygen-Filter-Perl-1.62/lib/Doxygen/Filter/Perl.pm
- ↑ http://www.stack.nl/~dimitri/doxygen/starting.html
- ↑ «Automatic Python API documentation generation tools». python.org wiki, 22-11-2015.
- ↑ https://pypi.python.org/pypi/doxypypy/
Enllaços externs
- Doxygen - Lloc web oficial
- Doxygen a SourceForge.net En SourceForge.Net
- Doxygen A Freecode
- Doxygen Ordres