Documentación

De CidesaWiki

(Diferencias entre revisiones)
Saltar a navegación, buscar
Línea 52: Línea 52:
* Si la función/clase no es estática no debe colcoarse el tag @static.
* Si la función/clase no es estática no debe colcoarse el tag @static.
-
Para major documentación de los tags que usa la herramineta PHPDocumentation pulsa aqui
+
Para major documentación de los tags que usa la herramineta PHPDocumentation pulsa [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.pkg.html aqui]

Revisión de 22:04 17 abr 2007

Cada Clase, función y variable global (o de clase) debe ser documentada de la siguinete forma:


/**
 * Herramientas Varias de manejo de datos.
 *
 * @package    Siga
 * @subpackage lib
 * @author     Grupo Desarrollo Cidesa <desarrollo@cidesa.com.ve>
 * @version    SVN: $Id: $
 * @copyright  Copyright 2007, Cidesa C.A.
 * 
 */
class Herramientas
{
	/**
	 * @static 
	 * @var string $prueba Definición del comentario de una variable.
	 */
	static $prueba = 'Variable de Prueba'; 
	

	/**
	 * Función para retornar datos a partir de una sentencia sql.
	 * Esta función retorna un arreglo de registros (Arreglo Bidimencional).
	 * @todo Agregar el manejo de errores de base de datos
	 *  
	 * @static
	 * @param string $sql Instrucción SQL.
	 * @param array &$output Arreglo bidimencional de respuesta.
	 * @return bool verdadero si encontro datos.
	 */ 
	public static function BuscarDatos($sql,&$output)
        {
             ..........
             ..........
	}
}


Se deben hacer las siguientes modificaciones:

Para major documentación de los tags que usa la herramineta PHPDocumentation pulsa aqui

Herramientas personales
Espacios de nombres
Variantes
Acciones
Navegación
Herramientas