LesOlivex

Serveis informàtics




Doxygen, conceptos básicos

Category : Documentación de código, doxygen des 21st, 2014

Documentación de código

Para que doxygen tenga en cuenta los comentarios deben tener el siguiente formato:

  • /** Comienza bloque comentado
  • */ Termina bloque
  • /// comentario de una linea
  • ///< Despues del elemento

Etiquetas generales:

Las etiquetas iran precedidas de ‘@’ o ‘\’

  • file
  • todo
  • author
  • param
  • return
  • version
  • see
  • tables para indicar las tablas que se utilizan de mysql
  • deprecated
  • brief
  • bug
  • code
  • example

Etiquetas de formato:

  • c fuente en monospace para la siguiente palabra
  • b negrita
  • e itálica

Paginas extras:

Se generan paginas sobre las etiquetas:
  • todo:  Tareas pendientes
  • bug: Lista de errores
  • example: Código de ejemplo
  • deprecated: Código en desuso

Ejemplos

Encabezado de fichero:

/**
 * @file
 *
 * @author    Eduardo Magrané
 *
 * @internal
 *   Created  24/11/09
 *  Revision  SVN $Id: $
 * Copyright  Copyright (c) 2009, Eduardo Magrané
 *
 * This source code is released for free distribution under the terms of the
 * GNU General Public License as published by the Free Software Foundation.
 */

Encabezado de clase:

/** Módulo Eventos
 *
 * Utilizamos los eventos como manera de interconectar a los módulos
 * Ejemplo de fichero de eventos de un módulo.
 *
 * @see modulos/editar/eventos_usuario.php
 *
 * @code
 * <?php
 *    $eventos['cabecerad']['formulario_busqueda'][1]='';
 *    $eventos['columna']['ultimas_entradas'][2]="num=7&seccion=".Router::$s."&formato=1";
 *    $eventos['contenido_dinamico']['contenido_dinamico'][1]='';
 *    $eventos['precarga']['presentar_busquedas'][3]='';
 *
 *    // Comportamiento de eventos
 *    $cEventos['contenido_dinamico'] = 'unico';
 * ?>
 * @endcode
 *
 * @author Eduardo Magrané
 *
 * @todo Cachear array de eventos
 */

Campos de datos:

/**
 * Array con los eventos de la aplicación
 */

public $eventos;

Metodo:

/**
 * Buscamos dentro de modulos los archivos directorio módulo/eventos_usuario.php
 * que tienen la información del módulo.
 */

function leer_eventos($nivel) {

Test:

Se generara una página nueva dentro de “Páginas relacionadas” con el nombre “Lista de pruebas”

/**
 * @test Comprobando GcmConfigFactory
 */

class GcmConfigFactoryTest extends PHPUnit_Framework_TestCase{

   /**
    * @test Comprobando valor de la primera variable
    */

   function testCambiarValores() {

      $this->assertEquals($this->config->get('v1'), 'variable1');

      }

   }

(1) Comment

technology
2 years ago · Reply

Work always pays off and I do believe you’re writing is a great example.

Leave a Reply

Your email address will not be published. Required fields are marked *