mamedu :: doxygen2
mamedu.gif

Programación y linux

doxygen2

24 de Marzo, 2010

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');

}

}

Últimas entradas en Documentar código
doxygen2

24 de Marzo, 2010

/ Apuntes / Programación / Documentar código

Ejemplos Encabezado de fichero: /** * @file * * @author Eduardo Magrané * * @internal * Created 24/11/09 * Revision SVN $Id: $ * Copyright Copyright (c) 2009, Eduardo Magrané...
Doxygen

15 de Noviembre, 2009

/ Apuntes / Programación / Documentar código

Documentación de código Para que doxygen tenga en cuenta los comentarios deben tener el siguiente formato:   //* Comienza bloque comentado */ Termina bloque /// comentari...
phpxref

30 de Abril, 2008

/ Apuntes / Programación / Documentar código

Otro programa que se complementa bien con doxygen utilizan las mismas reglas para la documentación referencia todas las variables y tambien las tablas...
Administrar

Nombre:

Contraseña: