Ir al contenido

Doxygen

De Mexpedia
Doxygen
Archivo:Doxygen.png
Información general
Tipo de programa Generador de documentación
Lanzamiento inicial 26 de octubre de 1997
Licencia GPL
Información técnica
Programado en C++
Versiones
Última versión estable 1.16.0 (info) (5 de enero de 2026 (9 meses y 6 días))
Enlaces
Página no enlazada a Wikidata y añade el enlace en español: Doxygen.

Doxygen es un generador de documentación para C++, C, Java, Objective-C, Python, Fortran, IDL (versiones Corba y Microsoft), VHDL y en cierta medida para PHP, C# y D. Dado que es fácilmente adaptable funciona en la mayoría de sistemas Unix, así como en Windows y Mac OS X. La mayor parte del código de Doxygen está escrita por Dimitri van Heesch.

Doxygen es un acrónimo de dox(document) gen(generator), generador de documentación para código fuente.

Varios proyectos como KDE usan Doxygen para generar la documentación de su API. KDevelop incluye soporte para Doxygen.

Código de ejemplo

[editar | editar código]

El siguiente ejemplo ilustra la forma de documentar un fichero fuente.

 /**
  * La clase Time representa un momento del tiempo.
  *
  * ''@author'' Nombre del Autor
  */
 '''class''' Time {

   /**
    * El constructor que inicializa el valor de tiempo.
    * ''@param'' '''timemillis''' Número de milisegundos desde el 1 de enero de 1970
    */
   Time('''int''' timemillis) {
    ...
   }

   /**
    * Obtener la hora actual.
    * ''@return'' Un objeto time, con la hora actual.
    */
   '''static''' Time now() {
    ...
   }
 }

Véase también

[editar | editar código]

Enlaces externos

[editar | editar código]