Documentación técnica

Existen muchos tipos de generadores de documentación, como son por ejemplo el Sandcastle, Javadoc, Doxygen, Sphinx, etc. El generador que investigare será el siguiente:

Droxygen

Este generador de documentación sirve para el lenguaje Java, C++, C, entre otros, este generador es muy fácil adaptarlo en la mayoría de los sistemas operativos (Unix, Windows, Mac OS X, etc).

Droxygen es un acrónimo de dox(document) y gen(generador).

Un ejemplo de cómo se documenta un fichero fuente es:

/**
 * 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() {
   ...
  }
}

Referencia :

Documentación técnica

Documentación de usuario

Documentación de sistemas

Doxygen