PHPDocumentator
- Área: Reglas Generales de Construcción de Aplicaciones PHP
- Carácter del recurso: Recomendado
Descripción
Es una herramienta destinada a la generación de autodocumentación de código en lenguaje PHP. Smimilar a Javadoc, y escrito en php, se puede usar tanto por línea de comando como por una interfaz web para crear documentación profesional de los proyectos con código fuente en php. Es capaz de enlazar documentación, crear niveles de la misma para diferentes usuarios, incluir referencias cruzadas e incorporar tutoriales
La herramienta hace uso de un sistema de plantillas para cambiar los comentarios introducidos en el código a una redacción interpretable. este sistema permite la creación sencilla de documentación en diferentes formatos como HTML, PDF, XML, etc.... se pueden crear las propias plantillas.
Ejemplos de uso
<?php
/**
* Ejemplo, phpDocumentor Quickstart
*
* Este archivo muestra el uso de la etiqueta @name
* @author MADEJA
* @version 1.0
* @package sample
*/
/**
* declaración de la variable global DocBlock
* @global integer $GLOBALS['_myvar']
*/
$GLOBALS['_myvar'] = 6;
/**
* Observe que la etiqueta @name tag no valida lo que se le introduce
* @global string $GLOBALS['turkey']
* @name $turkify
*/
$GLOBALS['turkey'] = 'tester';
/**
* Ejemplo simple de uso de la función @global
*
* Observe que la variable $turkey no esta enlazada en la documentación
* {@link $turkify} porque se ha realizado un mal ejemplo de uso de la etiqueta @name
* @global integer
* @global string Representa ala descripción opcional
*/
function testit()
{
global $_myvar, $turkey;
}
?>
Ventajas e inconvenientes
- La documentación generada podrá incluir tutoriales o manuales, para lo que se utilizará de usar la sintaxis de DocBook. Los tutoriales, en pocas palabras, se incorporan al proyecto en su propio directorio, y son utilizados por PhpDocumentor para obtener de ellos la información que contienen y situarla dentro de la documentación de nuestro proyecto
- Salida en varios formatos (HTMML, PDF, CHM, XML)
- Crea documentación diferenciada para diferentes grupos de usuarios a partir de la anotación @private
- Es muy rápido. Permite la ejecución por línea de comandos y por interfaz web
- Herramienta muy bien documentadas
Requisitos e incompatibilidades
- PHP versión 4.1.0 o mayor
- Hace uso de Pear para su instalación o puede directamente instalarse en el Web Server
Interacciones
Sigue la estructura de funcionamiento de Javadoc para la edición de documentación en Java aunque aumenta las posibilidades que este ofrece permitiendo la inserción de ejemplo de código y manuales. Interpreta de forma exitosa la sintaxis propuesta por esta herramienta favoreciendo la comprensión a los desarrolladores habituados a la misma.
Enlaces externos
Contenidos relacionados
Código | Título | Tipo | Carácter |
---|---|---|---|
RECU-0109 | JAVADOC | Herramienta | Recomendado |